Skip to content

docs(vue-query/queryClient): add the descriptions of the deprecated 'ensureQueryData', 'fetchQuery', 'prefetchQuery', 'fetchInfiniteQuery', and 'prefetchInfiniteQuery' overrides - #12212

Merged
sukvvon merged 1 commit into
mainfrom
docs/vue-query-client-deprecated-descriptions
Oct 20, 2026

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 20, 2026

Copy link
Copy Markdown
Member

🎯 Changes

  • Add the description, @param, and @returns text to the first overload of the deprecated ensureQueryData, fetchQuery, prefetchQuery, fetchInfiniteQuery, and prefetchInfiniteQuery overrides in packages/vue-query/src/queryClient.ts, matching @tanstack/query-core. Their own @deprecated JSDoc kept TypeDoc from inheriting it, so both signatures had no description.
  • Add {@inheritDoc QueryClient.<method>:0} with the same @deprecated tag to the second (MaybeRefDeep) overload of each method.
  • Regenerate docs/framework/vue/reference/classes/QueryClient.md.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

…ensureQueryData', 'fetchQuery', 'prefetchQuery', 'fetchInfiniteQuery', and 'prefetchInfiniteQuery' overrides
@sukvvon sukvvon self-assigned this Oct 20, 2026
@changeset-bot

changeset-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3feee17

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@nx-cloud

nx-cloud Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 3feee17

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

☁️ Nx Cloud last updated this comment at 2026-10-20 12:57:42 UTC

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@sukvvon
sukvvon merged commit 90e331d into main Oct 20, 2026
7 of 8 checks passed
@sukvvon
sukvvon deleted the docs/vue-query-client-deprecated-descriptions branch October 20, 2026 12:55
@coderabbitai

coderabbitai Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: Repository: TanStack/query/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ef08c582-5fd0-4fc4-850e-3bf71daa2910
📥 Commits

Reviewing files that changed from the base of the PR and between 7b9a85e and 3feee17.

📒 Files selected for processing: 2
  • docs/framework/vue/reference/classes/QueryClient.md
  • packages/vue-query/src/queryClient.ts
+--------------------------------------------------+
| My OKRs are all about finding bugs in your code. |
+--------------------------------------------------+
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.76 KB (0%)
react minimal 8.59 KB (0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant