Skip to content

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

Merged
TkDodo merged 2 commits intoTanStack: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 intoTanStack:mainfrom
neefrehman:fix/key-type-support-readonly

Conversation

@neefrehman
Copy link
Copy Markdown
Contributor

@neefrehman neefrehman commented Jan 13, 2025

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
Copy link
Copy Markdown

nx-cloud Bot commented Jan 13, 2025

View your CI Pipeline Execution ↗ for commit 35beb72.

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

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

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Jan 13, 2025

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
Copy link
Copy Markdown

codecov Bot commented Jan 13, 2025

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     
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.92% <ø> (+0.72%) ⬆️
@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 TkDodo merged commit 8d174c8 into TanStack:main Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants