Skip to content

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

Merged
TkDodo merged 2 commits into
TanStack:mainfrom
neefrehman:fix/key-type-support-readonly
Jan 13, 2025
Merged

fix(types): support both Array and ReadonlyArray for typed query and mutation keys#8529
TkDodo merged 2 commits into
TanStack:mainfrom
neefrehman:fix/key-type-support-readonly

Conversation

@neefrehman

@neefrehmanneefrehman commented Jan 13, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Follow-up to #8521

When using this new feature I've realised that it currently doesn't support ReadonlyArrays, as they don't extend the Array type, which I didn't appreciate until now. Some users may want to provide a ReadonlyArray to Register for extra type safety. This PR updates the inference so that it will support both.

@nx-cloud

nx-cloudBot commented Jan 13, 2025•
edited
Loading

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 35beb72.

CommandStatusDurationResult
nx affected --targets=test:sherif,test:knip,tes...✅ Succeeded3m 33sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1m 11sView ↗

☁️ Nx Cloud last updated this comment at 2025-01-13 11:49:05 UTC

@pkg-pr-new

pkg-pr-newBot commented Jan 13, 2025

Copy link
Copy Markdown

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/query-async-storage-persister

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

@tanstack/angular-query-experimental

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-persist-client

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

@tanstack/react-query-next-experimental

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 35beb72

@codecov

codecovBot commented Jan 13, 2025•
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.04%. Comparing base (8ddebc6) to head (35beb72).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@ Coverage Diff @@## main #8529 +/- ##
===========================================
+ Coverage 46.28% 63.04% +16.76% 
===========================================
Files 199 135 -64 Lines 7538 4820 -2718 Branches 1722 1347 -375 ===========================================
- Hits 3489 3039 -450 + Misses 3670 1549 -2121 + Partials 379 232 -147
ComponentsCoverage Δ
@tanstack/angular-query-devtools-experimental∅ <ø> (∅)
@tanstack/angular-query-experimental88.65% <ø> (ø)
@tanstack/eslint-plugin-query∅ <ø> (∅)
@tanstack/query-async-storage-persister43.85% <ø> (ø)
@tanstack/query-broadcast-client-experimental∅ <ø> (∅)
@tanstack/query-codemods∅ <ø> (∅)
@tanstack/query-core94.15% <ø> (ø)
@tanstack/query-devtools4.78% <ø> (ø)
@tanstack/query-persist-client-core57.73% <ø> (ø)
@tanstack/query-sync-storage-persister84.61% <ø> (ø)
@tanstack/react-query95.94% <ø> (ø)
@tanstack/react-query-devtools10.00% <ø> (ø)
@tanstack/react-query-next-experimental∅ <ø> (∅)
@tanstack/react-query-persist-client100.00% <ø> (ø)
@tanstack/solid-query78.92% <ø> (+0.72%)⬆️
@tanstack/solid-query-devtools∅ <ø> (∅)
@tanstack/solid-query-persist-client100.00% <ø> (ø)
@tanstack/svelte-query87.33% <ø> (ø)
@tanstack/svelte-query-devtools∅ <ø> (∅)
@tanstack/svelte-query-persist-client100.00% <ø> (ø)
@tanstack/vue-query71.01% <ø> (ø)
@tanstack/vue-query-devtools∅ <ø> (∅)

@TkDodo
TkDodo merged commit 8d174c8 into TanStack:mainJan 13, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TkDodoTkDodoTkDodo approved these changes

Assignees

No one assigned

Labels

package: query-core

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@neefrehman@TkDodo