docs({react,solid}-query): add missing 'errorUpdateCount' to 'useQuery' return signature by KangaZero · Pull Request #11041 · TanStack/query

KangaZero · 2026-07-10T01:21:55Z

Summary

errorUpdateCount is fully documented in the Returns section of the useQuery reference pages but was missing from the top-of-page destructuring block — the first thing a reader sees when scanning the API.

Affected files:

docs/framework/react/reference/useQuery.md
docs/framework/solid/reference/useQuery.md

The top-of-page destructuring block is ordered alphabetically, so errorUpdateCount is inserted right before errorUpdatedAt (errorUpdateC… < errorUpdatedA…):

  error,
+ errorUpdateCount,
  errorUpdatedAt,
  failureCount,

The Returns section below follows the field-definition order from packages/query-core/src/types.ts instead, where errorUpdateCount is already listed after failureReason — that section is left unchanged.

How did you test this change?

Documentation-only change — no runtime behavior affected, no tests needed. Verified by:

Confirming errorUpdateCount is already present in the Returns section of both files, and was only absent from the destructuring block.
Confirming the destructuring blocks in both files are alphabetically ordered, so errorUpdateCount belongs before errorUpdatedAt.

Summary by CodeRabbit

Documentation
- Updated the React and Solid useQuery documentation examples to destructure and display errorUpdateCount from the hook’s return value.

…gnature

coderabbitai · 2026-07-10T01:22:54Z

📝 Walkthrough

Walkthrough

The React and Solid useQuery reference examples now include errorUpdateCount among the destructured return values.

Changes

useQuery documentation

Layer / File(s)	Summary
Document returned query state `docs/framework/react/reference/useQuery.md`, `docs/framework/solid/reference/useQuery.md`	The React and Solid `useQuery` examples now destructure `errorUpdateCount` from the hook result.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
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 clearly matches the docs-only change to add errorUpdateCount to useQuery return examples for React and Solid.
Description check	✅ Passed	The description explains the change and testing, but it omits the template's Checklist and Release Impact sections.

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

…nature

nx-cloud · 2026-07-12T18:20:22Z

View your CI Pipeline Execution ↗ for commit 514fcea

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

☁️ Nx Cloud last updated this comment at 2026-07-12 18:24:59 UTC

… preserve alphabetical order

pkg-pr-new · 2026-07-12T18:24:47Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: dce1ba3

docs(react-query): add missing errorUpdateCount to useQuery return si…

533050c

…gnature

KangaZero and others added 2 commits July 10, 2026 10:28

docs(react-query): move errorUpdateCount after errorUpdatedAt

819d450

Merge branch 'main' into docs/add-error-update-count-to-use-query-sig…

514fcea

…nature

docs(react-query): keep 'errorUpdateCount' before 'errorUpdatedAt' to…

dce1ba3

… preserve alphabetical order

sukvvon changed the title ~~docs(react-query): add missing errorUpdateCount to useQuery return signature~~ docs({react,solid}-query): add missing 'errorUpdateCount' to 'useQuery' return signature Jul 12, 2026

sukvvon approved these changes Jul 12, 2026

View reviewed changes

sukvvon merged commit f6cf120 into TanStack:main Jul 12, 2026
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs({react,solid}-query): add missing 'errorUpdateCount' to 'useQuery' return signature#11041

docs({react,solid}-query): add missing 'errorUpdateCount' to 'useQuery' return signature#11041
sukvvon merged 4 commits into
TanStack:mainfrom
KangaZero:docs/add-error-update-count-to-use-query-signature

KangaZero commented Jul 10, 2026 •

edited by sukvvon

Loading

Uh oh!

coderabbitai Bot commented Jul 10, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

nx-cloud Bot commented Jul 12, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Jul 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

KangaZero commented Jul 10, 2026 • edited by sukvvon Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

How did you test this change?

Summary by CodeRabbit

Uh oh!

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

Uh oh!

Walkthrough

Changes

Uh oh!

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

Uh oh!

Uh oh!

pkg-pr-new Bot commented Jul 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

KangaZero commented Jul 10, 2026 •

edited by sukvvon

Loading

coderabbitai Bot commented Jul 10, 2026 •

edited

Loading

nx-cloud Bot commented Jul 12, 2026 •

edited

Loading