feat(types): support typing `QueryKey` and `MutationKey` via `Register` #8521

neefrehman · 2025-01-10T12:36:10Z

Follow-on from #8495

This PR extends the use of the Register interface so that it can narrow the type of QueryKey and MutationKey, for situations where users of the library want to enforce a hierarchy of keys at the lowest-level possible.

TkDodo

great work, thank you 🚀

nx-cloud · 2025-01-10T13:16:19Z

View your CI Pipeline Execution ↗ for commit 2b07bbe.

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	3m 6s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	1m 9s	View ↗

☁️ Nx Cloud last updated this comment at 2025-01-10 15:23:12 UTC

autofix-ci · 2025-01-10T13:16:56Z

Hi! I'm autofix.ci, a bot that automatically fixes trivial issues such as code formatting in pull requests.

I would like to apply some automated changes to this pull request, but it looks like I don't have the necessary permissions to do so. To get this pull request into a mergeable state, please do one of the following two things:

Allow edits by maintainers for your pull request, and then re-trigger CI (for example by pushing a new commit).
Manually fix the issues identified for your pull request (see the GitHub Actions output for details on what I would like to change).

neefrehman · 2025-01-10T13:24:18Z

@TkDodo thanks! I've just fixed the failing build, so hopefully a rerun will be green 🤞🏾

pkg-pr-new · 2025-01-10T13:39:13Z

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@8521

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@8521

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@8521

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@8521

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@8521

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@8521

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@8521

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@8521

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@8521

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@8521

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@8521

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@8521

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@8521

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@8521

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@8521

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@8521

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@8521

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@8521

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@8521

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@8521

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@8521

commit: 2b07bbe

codecov · 2025-01-10T13:45:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.04%. Comparing base (e2bc216) to head (ce6952b).
Report is 2 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #8521       +/-   ##
===========================================
+ Coverage   46.28%   63.04%   +16.76%     
===========================================
  Files         199      135       -64     
  Lines        7538     4833     -2705     
  Branches     1722     1354      -368     
===========================================
- Hits         3489     3047      -442     
+ Misses       3670     1542     -2128     
+ Partials      379      244      -135

Components	Coverage Δ
@tanstack/angular-query-devtools-experimental	`∅ <ø> (∅)`
@tanstack/angular-query-experimental	`88.65% <ø> (ø)`
@tanstack/eslint-plugin-query	`∅ <ø> (∅)`
@tanstack/query-async-storage-persister	`43.85% <ø> (ø)`
@tanstack/query-broadcast-client-experimental	`∅ <ø> (∅)`
@tanstack/query-codemods	`∅ <ø> (∅)`
@tanstack/query-core	`94.15% <ø> (ø)`
@tanstack/query-devtools	`4.78% <ø> (ø)`
@tanstack/query-persist-client-core	`57.73% <ø> (ø)`
@tanstack/query-sync-storage-persister	`84.61% <ø> (ø)`
@tanstack/react-query	`95.94% <ø> (ø)`
@tanstack/react-query-devtools	`10.00% <ø> (ø)`
@tanstack/react-query-next-experimental	`∅ <ø> (∅)`
@tanstack/react-query-persist-client	`100.00% <ø> (ø)`
@tanstack/solid-query	`78.20% <ø> (ø)`
@tanstack/solid-query-devtools	`∅ <ø> (∅)`
@tanstack/solid-query-persist-client	`100.00% <ø> (ø)`
@tanstack/svelte-query	`87.33% <ø> (ø)`
@tanstack/svelte-query-devtools	`∅ <ø> (∅)`
@tanstack/svelte-query-persist-client	`100.00% <ø> (ø)`
@tanstack/vue-query	`71.01% <ø> (ø)`
@tanstack/vue-query-devtools	`∅ <ø> (∅)`

TkDodo · 2025-01-10T14:31:47Z

autofix is still failing. please run prettier or allow updates by maintainers so that this can be fixed by the bot!

neefrehman · 2025-01-10T15:12:12Z

@TkDodo thanks! annoyingly prettier was unable to find any fixes (at least with how I was running it in my Codespace). I've just allowed maintainer edits, and have pushed a new commit

github-actions bot added documentation Improvements or additions to documentation package: query-core labels Jan 10, 2025

TkDodo approved these changes Jan 10, 2025

View reviewed changes

neefrehman changed the title ~~feat(types): support typing QueryKey and MutationKey via Register~~ feat(types): support typing QueryKey and MutationKey via Register Jan 10, 2025

feat(types): support typing QueryKey and MutationKey via Register

b4ea0d6

neefrehman force-pushed the feature/typing-query-keys branch from ce6952b to b4ea0d6 Compare January 10, 2025 15:10

TkDodo and others added 2 commits January 10, 2025 16:14

Merge branch 'main' into feature/typing-query-keys

ffa81e1

ci: apply automated fixes

2b07bbe

TkDodo merged commit fd500a4 into TanStack:main Jan 10, 2025
6 checks passed

neefrehman mentioned this pull request Jan 13, 2025

fix(types): support both Array and ReadonlyArray for typed query and mutation keys #8529

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(types): support typing `QueryKey` and `MutationKey` via `Register` #8521

feat(types): support typing `QueryKey` and `MutationKey` via `Register` #8521

neefrehman commented Jan 10, 2025

TkDodo left a comment

nx-cloud bot commented Jan 10, 2025 •

edited

Loading

autofix-ci bot commented Jan 10, 2025

neefrehman commented Jan 10, 2025

pkg-pr-new bot commented Jan 10, 2025 •

edited

Loading

codecov bot commented Jan 10, 2025

TkDodo commented Jan 10, 2025

neefrehman commented Jan 10, 2025

feat(types): support typing QueryKey and MutationKey via Register #8521

feat(types): support typing QueryKey and MutationKey via Register #8521

Conversation

neefrehman commented Jan 10, 2025

TkDodo left a comment

Choose a reason for hiding this comment

nx-cloud bot commented Jan 10, 2025 • edited Loading

autofix-ci bot commented Jan 10, 2025

neefrehman commented Jan 10, 2025

pkg-pr-new bot commented Jan 10, 2025 • edited Loading

codecov bot commented Jan 10, 2025

Codecov Report

TkDodo commented Jan 10, 2025

neefrehman commented Jan 10, 2025

feat(types): support typing `QueryKey` and `MutationKey` via `Register` #8521

feat(types): support typing `QueryKey` and `MutationKey` via `Register` #8521

nx-cloud bot commented Jan 10, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 10, 2025 •

edited

Loading