query icon indicating copy to clipboard operation
query copied to clipboard

type(vue-query): introduce `ShallowOption` to unify `shallow` type and JSDoc

Open Mini-ghost opened this issue 8 months ago β€’ 3 comments

This PR introduces a shared ShallowOption type to unify the shallow?: boolean option and its JSDoc across various composables in @tanstack/vue-query.

If there is anything I might have missed, please feel free to let me know. Thank you!

Mini-ghost avatar Jun 13 '25 18:06 Mini-ghost

View your CI Pipeline Execution β†— for commit 17ff9f5f937481295d87817c38ff7e3eca9dbdb3.

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... βœ… Succeeded 1m 9s View β†—
nx run-many --target=build --exclude=examples/*... βœ… Succeeded 19s View β†—

☁️ Nx Cloud last updated this comment at 2025-06-26 23:12:30 UTC

nx-cloud[bot] avatar Jun 13 '25 18:06 nx-cloud[bot]

More templates

@tanstack/angular-query-devtools-experimental

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

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@9277
@tanstack/eslint-plugin-query

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

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@9277
@tanstack/query-broadcast-client-experimental

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

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

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

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@9277
@tanstack/query-sync-storage-persister

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 17ff9f5

pkg-pr-new[bot] avatar Jun 13 '25 18:06 pkg-pr-new[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 71.10%. Comparing base (b180d83) to head (17ff9f5). Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #9277       +/-   ##
===========================================
+ Coverage   45.37%   71.10%   +25.72%     
===========================================
  Files         207       19      -188     
  Lines        8277      481     -7796     
  Branches     1870      139     -1731     
===========================================
- Hits         3756      342     -3414     
+ Misses       4080      109     -3971     
+ Partials      441       30      -411     
Components Coverage Ξ”
@tanstack/angular-query-devtools-experimental βˆ… <ΓΈ> (βˆ…)
@tanstack/angular-query-experimental βˆ… <ΓΈ> (βˆ…)
@tanstack/eslint-plugin-query βˆ… <ΓΈ> (βˆ…)
@tanstack/query-async-storage-persister βˆ… <ΓΈ> (βˆ…)
@tanstack/query-broadcast-client-experimental βˆ… <ΓΈ> (βˆ…)
@tanstack/query-codemods βˆ… <ΓΈ> (βˆ…)
@tanstack/query-core βˆ… <ΓΈ> (βˆ…)
@tanstack/query-devtools βˆ… <ΓΈ> (βˆ…)
@tanstack/query-persist-client-core βˆ… <ΓΈ> (βˆ…)
@tanstack/query-sync-storage-persister βˆ… <ΓΈ> (βˆ…)
@tanstack/query-test-utils βˆ… <ΓΈ> (βˆ…)
@tanstack/react-query βˆ… <ΓΈ> (βˆ…)
@tanstack/react-query-devtools βˆ… <ΓΈ> (βˆ…)
@tanstack/react-query-next-experimental βˆ… <ΓΈ> (βˆ…)
@tanstack/react-query-persist-client βˆ… <ΓΈ> (βˆ…)
@tanstack/solid-query βˆ… <ΓΈ> (βˆ…)
@tanstack/solid-query-devtools βˆ… <ΓΈ> (βˆ…)
@tanstack/solid-query-persist-client βˆ… <ΓΈ> (βˆ…)
@tanstack/svelte-query βˆ… <ΓΈ> (βˆ…)
@tanstack/svelte-query-devtools βˆ… <ΓΈ> (βˆ…)
@tanstack/svelte-query-persist-client βˆ… <ΓΈ> (βˆ…)
@tanstack/vue-query 71.10% <ΓΈ> (ΓΈ)
@tanstack/vue-query-devtools βˆ… <ΓΈ> (βˆ…)
:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Jun 13 '25 18:06 codecov[bot]