test(vue-query/queryOptions): add type tests for 'useQueries', 'query' with 'enabled: false' and 'skipToken', and undefined 'initialData' by sukvvon · Pull Request #12309 · TanStack/query

sukvvon · 2026-10-23T17:00:43Z

🎯 Changes

Add type tests to queryOptions.test-d.ts that react-query has and vue-query was missing:

should work when passed to useQueries
should work when passed to query with enabled: false
should work when passed to query with skipToken
should allow undefined response in initialData

The useQueries test reads the results through .value, like the other vue-query type tests.

✅ 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

Tests
- Expanded TypeScript coverage for query result inference when using queryOptions with useQueries and QueryClient.query, including disabled queries, skipToken, and nullable IDs with initialData.

…' with 'enabled: false' and 'skipToken', and undefined 'initialData'

changeset-bot · 2026-10-23T17:00:48Z

⚠️ No Changeset found

Latest commit: c87f6f5

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-23T17:01:08Z

View your CI Pipeline Execution ↗ for commit c87f6f5

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

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

github-actions · 2026-10-23T17:01:42Z

🚀 Changeset Version Preview

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

🟩 Patch bumps

Package	Version	Reason
`@tanstack/vue-query`	5.104.5 → 5.104.6	Changeset
`@tanstack/angular-query-experimental`	5.104.5 → 5.104.6	Dependent
`@tanstack/eslint-plugin-query`	5.104.5 → 5.104.6	Dependent
`@tanstack/lit-query`	0.2.30 → 0.2.31	Dependent
`@tanstack/preact-query`	5.104.5 → 5.104.6	Dependent
`@tanstack/preact-query-devtools`	5.104.5 → 5.104.6	Dependent
`@tanstack/preact-query-persist-client`	5.104.5 → 5.104.6	Dependent
`@tanstack/query-async-storage-persister`	5.104.5 → 5.104.6	Dependent
`@tanstack/query-broadcast-client-experimental`	5.104.5 → 5.104.6	Dependent
`@tanstack/query-core`	5.104.5 → 5.104.6	Dependent
`@tanstack/query-devtools`	5.104.5 → 5.104.6	Dependent
`@tanstack/query-persist-client-core`	5.104.5 → 5.104.6	Dependent
`@tanstack/query-sync-storage-persister`	5.104.5 → 5.104.6	Dependent
`@tanstack/react-query`	5.104.5 → 5.104.6	Dependent
`@tanstack/react-query-devtools`	5.104.5 → 5.104.6	Dependent
`@tanstack/react-query-next-experimental`	5.104.5 → 5.104.6	Dependent
`@tanstack/react-query-persist-client`	5.104.5 → 5.104.6	Dependent
`@tanstack/solid-query`	5.104.5 → 5.104.6	Dependent
`@tanstack/solid-query-devtools`	5.104.5 → 5.104.6	Dependent
`@tanstack/solid-query-persist-client`	5.104.5 → 5.104.6	Dependent
`@tanstack/svelte-query`	6.3.5 → 6.3.6	Dependent
`@tanstack/svelte-query-devtools`	6.3.5 → 6.3.6	Dependent
`@tanstack/svelte-query-persist-client`	6.3.5 → 6.3.6	Dependent
`@tanstack/vue-query-devtools`	6.3.5 → 6.3.6	Dependent

coderabbitai · 2026-10-23T17:02:15Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Source mode: Auto
Repository: TanStack/query
Branch: test/vue-query-query-options-type-tests
File: .coderabbit.yaml
Commit: c87f6f5
Layers: Repository YAML
Review profile: CHILL
Plan: Advanced
Run ID: 34368dd2-cd5c-4aa3-9faa-71294c923aea

📥 Commits

Reviewing files that changed from the base of the PR and between 394ea29 and c87f6f5.

📒 Files selected for processing: 1

packages/vue-query/src/__tests__/queryOptions.test-d.ts

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

📝 Walkthrough

The pull request adds Vue Query type tests for queryOptions when used with useQueries, QueryClient.query, and nullable query keys with initialData that can return undefined.

Changes: Vue Query query option types

Layer / File(s)	Summary
Query option typing assertions `packages/vue-query/src/__tests__/queryOptions.test-d.ts`	Adds type assertions for `queryOptions` in `useQueries`, `QueryClient.query` with `enabled: false` and `skipToken`, and nullable query keys with `initialData` that can return `undefined`. Includes the `useQueries` import.

Priority: ⬇️ Low

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

Change: Other

Possibly related PRs

TanStack/query#12293: Renames the query test utility helper to createKey and updates the same Vue Query type test file.

Suggested reviewers: dogpawhat, damianosipiuk

Merge Risk: ⚪ Minimal · up to c87f6

No actionable issue is established for these type-test additions; the change is mergeable after normal checks.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title clearly summarizes the added Vue Query type tests and identifies all key scenarios covered by the changes.
Description check		The description explains the changes, lists all four test cases, documents test execution, completes the checklist, and identifies the change as docs/CI/dev-only.
Docstring Coverage		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 1…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

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 1 files.

✨ 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.}

pkg-pr-new · 2026-10-23T17:03:15Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: c87f6f5

github-actions · 2026-10-23T17:03:25Z

size-limit report 📦

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

test(vue-query/queryOptions): add type tests for 'useQueries', 'query…

c87f6f5

…' with 'enabled: false' and 'skipToken', and undefined 'initialData'

sukvvon self-assigned this Oct 23, 2026

sukvvon merged commit 86740ae into main Oct 23, 2026
9 checks passed

sukvvon deleted the test/vue-query-query-options-type-tests branch October 23, 2026 17:13

Navigation Menu

Repository navigation

test(vue-query/queryOptions): add type tests for 'useQueries', 'query' with 'enabled: false' and 'skipToken', and undefined 'initialData' - #12309

test(vue-query/queryOptions): add type tests for 'useQueries', 'query' with 'enabled: false' and 'skipToken', and undefined 'initialData'#12309
sukvvon merged 1 commit into
mainfrom
test/vue-query-query-options-type-tests

sukvvon commented Oct 23, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 23, 2026

Uh oh!

nx-cloud Bot commented Oct 23, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 23, 2026

Uh oh!

coderabbitai Bot commented Oct 23, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Oct 23, 2026

Uh oh!

github-actions Bot commented Oct 23, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 23, 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 23, 2026

⚠️ No Changeset found

Uh oh!

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

Uh oh!

Uh oh!

github-actions Bot commented Oct 23, 2026

🚀 Changeset Version Preview

🟩 Patch bumps

Uh oh!

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

Uh oh!

Uh oh!

pkg-pr-new Bot commented Oct 23, 2026

Uh oh!

github-actions Bot commented Oct 23, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 23, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Oct 23, 2026 •

edited

Loading

coderabbitai Bot commented Oct 23, 2026 •

edited

Loading