Skip to content

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

Open
sukvvon wants to merge 2 commits into
mainfrom
docs/document-throwonerror-default-solid
Open

docs(solid-query/useQuery): document 'throwOnError' default value and its exceptions#11170
sukvvon wants to merge 2 commits into
mainfrom
docs/document-throwonerror-default-solid

Conversation

@sukvvon

@sukvvon sukvvon commented Aug 12, 2026

Copy link
Copy Markdown
Member

Summary

  • Add Optional / Defaults to false`` to the throwOnError option, matching the documentation pattern used by other options (`refetchOnMount`, `refetchOnWindowFocus`)
  • Document that the default is true during SSR, and true when the deprecated suspense option is set to true

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: c62a0e44-77bd-446f-8ea4-98801d807d7f

📥 Commits

Reviewing files that changed from the base of the PR and between fc2210a and 4e3b235.

📒 Files selected for processing (1)
  • docs/framework/solid/reference/useQuery.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/framework/solid/reference/useQuery.md

📝 Walkthrough

Walkthrough

The Solid useQuery reference now states that throwOnError is optional. It documents defaults of false normally and true during SSR or when deprecated suspense is enabled.

Changes

Solid useQuery documentation

Layer / File(s) Summary
Document throwOnError default
docs/framework/solid/reference/useQuery.md
The parameter documentation states that throwOnError is optional, defaults to false normally, and defaults to true during SSR or when deprecated suspense is enabled.

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

Possibly related PRs

🚥 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 Checklist and Release Impact sections. Add the required Checklist and Release Impact sections, and mark the applicable items.
✅ 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 documentation update and the specific throwOnError default behavior being documented.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/document-throwonerror-default-solid

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

nx-cloud Bot commented Aug 12, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit fc2210a

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

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

@sukvvon sukvvon self-assigned this Aug 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/framework/solid/reference/useQuery.md`:
- Around line 293-295: Update the throwOnError option documentation to qualify
the false default: state that it applies when suspense is disabled in client
usage, and document the SSR and suspense-enabled exceptions reflected by
useBaseQuery and QueryClient behavior.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e55daf65-f81d-465c-8b96-1df12a8c64a9

📥 Commits

Reviewing files that changed from the base of the PR and between 159982c and fc2210a.

📒 Files selected for processing (1)
  • docs/framework/solid/reference/useQuery.md

Comment thread docs/framework/solid/reference/useQuery.md
@pkg-pr-new

pkg-pr-new Bot commented Aug 12, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 4e3b235

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

@TanStack TanStack deleted a comment from coderabbitai Bot Aug 12, 2026
@sukvvon sukvvon changed the title docs(solid-query/useQuery): document 'throwOnError' default value docs(solid-query/useQuery): document 'throwOnError' default value and its exceptions Aug 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant