docs(react-query/useQuery): document 'throwOnError' default value by sukvvon · Pull Request #11156 · TanStack/query

sukvvon · 2026-08-09T05:15:11Z

Summary

Add Optional / Defaults to false`` to the throwOnError option, matching the documentation pattern used by other options (`subscribed`, `refetchOnMount`, `refetchOnWindowFocus`)

…bsence in suspense hooks

coderabbitai · 2026-08-09T05:15:32Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f421203f-2cd7-43aa-af9e-f1b9f1eb5abf

📥 Commits

Reviewing files that changed from the base of the PR and between 4005b63 and f1a4093.

📒 Files selected for processing (1)

docs/framework/react/reference/useQuery.md

💤 Files with no reviewable changes (1)

docs/framework/react/reference/useQuery.md

📝 Walkthrough

Walkthrough

The useQuery reference now documents that throwOnError is optional and defaults to false. Its behavior descriptions remain unchanged.

Changes

React query documentation

Layer / File(s)	Summary
Clarify `throwOnError` options `docs/framework/react/reference/useQuery.md`	Documents `throwOnError` as optional with a default value of `false`.

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

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description explains the documentation change but omits the required Changes, Checklist, and Release Impact sections from the template.	Use the repository template and complete the Changes, Checklist, and Release Impact sections, including the docs-only release checkbox.

✅ Passed checks (4 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 identifies the React Query documentation change for the `throwOnError` default value.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/document-throwonerror-default

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

nx-cloud · 2026-08-09T05:15:36Z

View your CI Pipeline Execution ↗ for commit 4005b63

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

☁️ Nx Cloud last updated this comment at 2026-08-12 01:00:09 UTC

github-actions · 2026-08-09T05:16:19Z

🚀 Changeset Version Preview

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

pkg-pr-new · 2026-08-09T05:19:38Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: f1a4093

github-actions · 2026-08-09T05:19:52Z

size-limit report 📦

Path	Size
react full	12.15 KB (0%)
react minimal	9.1 KB (0%)

…se throwOnError note

…ror note

docs(react-query/useQuery): document 'throwOnError' default and its a…

14e17a0

…bsence in suspense hooks

sukvvon self-assigned this Aug 11, 2026

sukvvon added 2 commits August 12, 2026 09:51

docs(react-query/useQuery): use framework-agnostic wording for suspen…

4005b63

…se throwOnError note

docs(react-query/useQuery): remove inaccurate suspense-mode throwOnEr…

f1a4093

…ror note

sukvvon changed the title ~~docs(react-query/useQuery): document 'throwOnError' default and its absence in suspense hooks~~ docs(react-query/useQuery): document 'throwOnError' default value Aug 12, 2026

sukvvon merged commit 159982c into main Aug 12, 2026
9 checks passed

sukvvon deleted the docs/document-throwonerror-default branch August 12, 2026 01:03

This was referenced Aug 12, 2026

docs(solid-query/useQuery): document 'throwOnError' default value and its exceptions #11170

Merged

docs(react-query/reference): remove stale 'suspense' references left over from the v5 suspense split #11200

Merged

Navigation Menu

Uh oh!

Uh oh!

docs(react-query/useQuery): document 'throwOnError' default value - #11156

docs(react-query/useQuery): document 'throwOnError' default value#11156
sukvvon merged 3 commits into
mainfrom
docs/document-throwonerror-default

sukvvon commented Aug 9, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 9, 2026 •

edited

Loading

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

nx-cloud Bot commented Aug 9, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 9, 2026

Uh oh!

pkg-pr-new Bot commented Aug 9, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Uh oh!

Conversation

sukvvon commented Aug 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

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

Uh oh!

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

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

Uh oh!

Uh oh!

github-actions Bot commented Aug 9, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Aug 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 9, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Aug 9, 2026 •

edited

Loading

coderabbitai Bot commented Aug 9, 2026 •

edited

Loading

nx-cloud Bot commented Aug 9, 2026 •

edited

Loading

pkg-pr-new Bot commented Aug 9, 2026 •

edited

Loading