docs(devtools): correct 'errorTypes' type to array by grzdev · Pull Request #10634 · TanStack/query

grzdev · 2026-05-05T02:26:33Z

🎯 Changes

Align the floating devtools docs with the exported errorTypes option type.

The Preact, Solid, Svelte, and Vue docs listed errorTypes as a single object, but the actual option is an array.

Docs-only change.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested this code locally with pnpm run test:pr.

🚀 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 errorTypes option type specifications across framework documentation (Preact, Solid, Svelte, Vue) with corrected TypeScript signatures and improved formatting for enhanced clarity.

coderabbitai · 2026-05-05T02:26:46Z

📝 Walkthrough

Walkthrough

The errorTypes option documentation is updated across four framework devtools guides (Preact, Solid, Svelte, Vue). Type signatures are corrected to reflect that errorTypes accepts an array of error configuration objects with name and initializer properties, ensuring consistency in API documentation.

Changes

Framework Devtools Documentation Updates

Layer / File(s)	Summary
Type Signature Corrections `docs/framework/preact/devtools.md`, `docs/framework/solid/devtools.md`, `docs/framework/svelte/devtools.md`, `docs/framework/vue/devtools.md`	The `errorTypes` option type annotation is updated to correctly document that it accepts an array of objects (`{ name: string; initializer: (query: Query) => TError }[]`) with properly formatted TypeScript signatures across all framework guides.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A hop through the docs, a fix here, a tweak there,
Framework friends dressed in their finest TypeScript wear,
Error types now arrayed in a line so neat,
Documentation's dance is finally complete! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description follows the template structure with completed Checklist and Release Impact sections, clearly explaining the change with appropriate justification.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Title check	✅ Passed	The title 'docs(devtools): correct 'errorTypes' type to array' accurately summarizes the main change: correcting documentation to reflect that errorTypes should be an array rather than a single object across multiple framework docs.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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 and usage tips.}

nx-cloud · 2026-05-05T02:27:11Z

View your CI Pipeline Execution ↗ for commit 13b9c00

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

☁️ Nx Cloud last updated this comment at 2026-05-05 02:28:37 UTC

pkg-pr-new · 2026-05-05T02:27:51Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 13b9c00

docs(devtools): document errorTypes as array

13b9c00

github-actions Bot added the documentation Improvements or additions to documentation label May 5, 2026

sukvvon approved these changes May 5, 2026

View reviewed changes

sukvvon changed the title ~~docs(devtools): document errorTypes as array~~ docs(devtools): correct 'errorTypes' type to array May 5, 2026

sukvvon merged commit 0d63459 into TanStack:main May 5, 2026
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(devtools): correct 'errorTypes' type to array#10634

docs(devtools): correct 'errorTypes' type to array#10634
sukvvon merged 1 commit intoTanStack:mainfrom
grzdev:docs/devtools-error-types-array

grzdev commented May 5, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented May 5, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

nx-cloud Bot commented May 5, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented May 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

grzdev commented May 5, 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!

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

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

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

Uh oh!

Uh oh!

pkg-pr-new Bot commented May 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

grzdev commented May 5, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 5, 2026 •

edited

Loading

nx-cloud Bot commented May 5, 2026 •

edited

Loading