refactor(vue-query): add the 'override' modifier to members that override a base class member by sukvvon · Pull Request #11905 · TanStack/query

sukvvon · 2026-10-04T17:31:11Z

🎯 Changes

Adds the TypeScript override modifier to the methods that QueryClient (including its overload signatures), QueryCache, and MutationCache override from their query-core base classes.

These wrappers unwrap the refs and getters before calling the base method. With override, TypeScript reports an error if a query-core method is renamed or removed, instead of silently leaving the wrapper as a new, unused method.

override is erased at compile time, so the built JS and the type declarations are unchanged. The generated reference docs only update "Defined in" line numbers, since some signatures now wrap.

✅ 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).

Summary by CodeRabbit

Documentation
- Updated source references for Vue QueryCache and QueryClient methods.
Refactor
- Clarified which cache and client methods override core methods; behavior and public APIs are unchanged.

…ride a base class member

changeset-bot · 2026-10-04T17:31:16Z

⚠️ No Changeset found

Latest commit: 69540c0

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 · 2026-10-04T17:32:26Z

View your CI Pipeline Execution ↗ for commit 69540c0

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

☁️ Nx Cloud last updated this comment at 2026-10-04 17:36:23 UTC

github-actions · 2026-10-04T17:32:28Z

🚀 Changeset Version Preview

1 package(s) bumped directly, 24 bumped as dependents.

🟩 Patch bumps

Package	Version	Reason
`@tanstack/query-core`	5.104.1 → 5.104.2	Changeset
`@tanstack/angular-query-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/angular-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/eslint-plugin-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/lit-query`	0.2.26 → 0.2.27	Dependent
`@tanstack/preact-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-async-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-broadcast-client-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-persist-client-core`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-sync-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-next-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/svelte-query`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-devtools`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-persist-client`	6.3.1 → 6.3.2	Dependent
`@tanstack/vue-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/vue-query-devtools`	6.3.1 → 6.3.2	Dependent

coderabbitai · 2026-10-04T17:32:50Z

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID: c9ad7521-3054-4a7f-a6ec-1dabd876a458

📥 Commits

Reviewing files that changed from the base of the PR and between 688f6e0 and 69540c0.

📒 Files selected for processing (5)

docs/framework/vue/reference/classes/QueryCache.md
docs/framework/vue/reference/classes/QueryClient.md
packages/vue-query/src/mutationCache.ts
packages/vue-query/src/queryCache.ts
packages/vue-query/src/queryClient.ts

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 1 remain after this review.

📝 Walkthrough

Walkthrough

Vue Query cache and client methods are now explicitly marked as overrides. The Vue reference documentation points to updated source locations. Method signatures and runtime behavior remain unchanged.

Changes

Vue Query override declarations

Layer / File(s)	Summary
Mark overrides and update source references `packages/vue-query/src/mutationCache.ts`, `packages/vue-query/src/queryCache.ts`, `packages/vue-query/src/queryClient.ts`, `docs/framework/vue/reference/classes/QueryCache.md`, `docs/framework/vue/reference/classes/QueryClient.md`	Cache and client methods are marked as overrides. Documentation source references are updated to match their new locations.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Refactor

Merge Risk: ⚪ Minimal · up to 69540

The change adds compile-time override markers and updates documentation links, with no runtime or API behavior change indicated. The links resolve correctly and no concrete merge-blocking defect is established, though the type-test matrix did not complete.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the main change: adding the TypeScript `override` modifier to members that override base class members.
Description check	✅ Passed	The description explains the change and its motivation, includes all template sections, and completes the checklist and release-impact fields.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 3…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autopilot · 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.}

pkg-pr-new · 2026-10-04T17:34:10Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@11905

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@11905

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@11905

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 69540c0

github-actions · 2026-10-04T17:34:21Z

size-limit report 📦

Path	Size
react full	11.73 KB (0%)
react minimal	8.58 KB (0%)

refactor(vue-query): add the 'override' modifier to members that over…

69540c0

…ride a base class member

sukvvon self-assigned this Oct 4, 2026

sukvvon merged commit 866d542 into main Oct 4, 2026
9 checks passed

sukvvon deleted the refactor/vue-query-add-override-modifiers branch October 4, 2026 18:21

Navigation Menu

Repository navigation

refactor(vue-query): add the 'override' modifier to members that override a base class member - #11905

refactor(vue-query): add the 'override' modifier to members that override a base class member#11905
sukvvon merged 1 commit into
mainfrom
refactor/vue-query-add-override-modifiers

sukvvon commented Oct 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 4, 2026

Uh oh!

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 4, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Oct 4, 2026

⚠️ No Changeset found

Uh oh!

nx-cloud Bot commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 4, 2026

🚀 Changeset Version Preview

🟩 Patch bumps

Uh oh!

coderabbitai Bot commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026

Uh oh!

github-actions Bot commented Oct 4, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 4, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading