Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jun 26, 2025
Merged

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

merged 2 commits into from
Jun 26, 2025

Conversation

Mini-ghost
Copy link
Contributor

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!

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Jun 13, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 17ff9f5.

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

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Jun 13, 2025 •
edited
Loading

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

@codecov Codecov
Copy link

codecov bot commented Jun 13, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

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 ∅ <ø> (∅)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@DamianOsipiuk DamianOsipiuk merged commit df56456 into TanStack:main Jun 26, 2025
7 checks passed
@Mini-ghost Mini-ghost deleted the types/shallow branch June 27, 2025 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
package: vue-query
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Mini-ghost @DamianOsipiuk