docs(react-query): add JSDoc to the exported classes, methods, and arrow functions by sukvvon · Pull Request #11880 · TanStack/query

sukvvon · 2026-10-04T03:15:57Z

🎯 Changes

Adds JSDoc (description, @param, @returns) to the exported classes, their non-private methods, and the exported arrow functions that didn't have one:

react-query-persist-client: PersistQueryClientProvider
react-query: ensurePreventErrorBoundaryRetry, useClearResetErrorBoundary, getHasError, defaultThrowOnError, ensureSuspenseTimers, shouldSuspend, fetchOptimistic

None of these are part of the generated reference docs.

✅ 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

Documentation
- Added documentation for query persistence restoration, fetching, and saving behavior.
- Expanded documentation for error-boundary handling and suspense behavior.

…row functions

changeset-bot · 2026-10-04T03:16:01Z

⚠️ No Changeset found

Latest commit: afb5f6c

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-04T03:16:22Z

View your CI Pipeline Execution ↗ for commit ba3a4b4

☁️ Nx Cloud last updated this comment at 2026-10-04 03:31:49 UTC

github-actions · 2026-10-04T03:16:59Z

🚀 Changeset Version Preview

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

🟩 Patch bumps

Package	Version	Reason
`@tanstack/query-core`	5.104.1 → 5.104.2	Changeset
`@tanstack/angular-query-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/angular-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/eslint-plugin-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/lit-query`	0.2.26 → 0.2.27	Dependent
`@tanstack/preact-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-async-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-broadcast-client-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-persist-client-core`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-sync-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-next-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/svelte-query`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-devtools`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-persist-client`	6.3.1 → 6.3.2	Dependent
`@tanstack/vue-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/vue-query-devtools`	6.3.1 → 6.3.2	Dependent

coderabbitai · 2026-10-04T03:18:02Z

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 3 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 10 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID: b2fc8b54-8d32-447e-95e7-d9d25d4e3a0a

📥 Commits

Reviewing files that changed from the base of the PR and between 11e3a34 and afb5f6c.

📒 Files selected for processing (3)

packages/react-query-persist-client/src/PersistQueryClientProvider.tsx
packages/react-query/src/errorBoundaryUtils.ts
packages/react-query/src/suspense.ts

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID: fe30c395-83f1-455f-aefd-dd8e1f90d311

📥 Commits

Reviewing files that changed from the base of the PR and between 5a8fa03 and 11e3a34.

📒 Files selected for processing (3)

packages/react-query-persist-client/src/PersistQueryClientProvider.tsx
packages/react-query/src/errorBoundaryUtils.ts
packages/react-query/src/suspense.ts

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

📝 Walkthrough

Walkthrough

This pull request adds documentation for PersistQueryClientProvider and for existing error-boundary and suspense utilities. It does not change executable behavior or public declarations.

Changes

React Query API documentation

Layer / File(s)	Summary
Persistence provider documentation `packages/react-query-persist-client/src/PersistQueryClientProvider.tsx`	A doc comment describes restoration state, query fetching during restoration, persistence, the provider props, and its return value.
Error-boundary and suspense utility documentation `packages/react-query/src/errorBoundaryUtils.ts`, `packages/react-query/src/suspense.ts`	JSDoc comments describe existing utility behavior, parameters, and return values.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: tkdodo

Merge Risk: ⚪ Minimal · up to 11e3a

This is a documentation-only change with no runtime behavior change. It is safe to merge, and a few doc phrases could optionally be made more precise later.

Architecture Summary

Architecture risk: 🔵 Low · up to 11e3a

The change affects 2 systems.

Changed systems: packages/react-query, packages/react-query-persist-client

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

observed — packages/react-query (library) was modified; 2 changed files map to changed impact.
observed — packages/react-query-persist-client (library) was modified; 1 changed file maps to changed impact.

Before / after behavior

observed — Modified behavior in packages/react-query-persist-client/src/PersistQueryClientProvider.tsx: Added a PersistQueryClientProvider doc comment describing restoration and persistence behavior, the restoring-state effect on queries, the callback and prop roles, and the returned wrapper.
observed — Modified behavior in packages/react-query/src/errorBoundaryUtils.ts: Added JSDoc describing when ensurePreventErrorBoundaryRetry disables retryOnMount, the options mutation, and its parameters.
observed — Modified behavior in packages/react-query/src/errorBoundaryUtils.ts: Added JSDoc describing useClearResetErrorBoundary clearing the boundary reset state after mount and documenting its parameter.
observed — Modified behavior in packages/react-query/src/errorBoundaryUtils.ts: Added JSDoc describing the conditions under which getHasError reports that an error should be thrown, its parameters, and return value.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the JSDoc additions, which are the main change in the pull request.
Description check	✅ Passed	The description explains the changes and includes all required template sections: Changes, Checklist, and Release Impact.
Docstring Coverage	✅ Passed	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 3…
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.

✨ Finishing Touches

📝 Generate docstrings

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autopilot · 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-04T03:18:09Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 11e3a34

github-actions · 2026-10-04T03:18:21Z

size-limit report 📦

Path	Size
react full	11.73 KB (0%)
react minimal	8.58 KB (0%)

… what is deferred while restoring and when the callbacks run

docs(react-query): add JSDoc to the exported classes, methods, and ar…

11e3a34

…row functions

sukvvon self-assigned this Oct 4, 2026

sukvvon added 2 commits October 4, 2026 12:31

Merge branch 'main' into docs/react-query-jsdoc-members

ba3a4b4

docs(react-query-persist-client/PersistQueryClientProvider): describe…

afb5f6c

… what is deferred while restoring and when the callbacks run

sukvvon merged commit b5e8e7b into main Oct 4, 2026
8 checks passed

sukvvon deleted the docs/react-query-jsdoc-members branch October 4, 2026 03:32

Navigation Menu

Repository navigation

docs(react-query): add JSDoc to the exported classes, methods, and arrow functions - #11880

docs(react-query): add JSDoc to the exported classes, methods, and arrow functions#11880
sukvvon merged 3 commits into
mainfrom
docs/react-query-jsdoc-members

sukvvon commented Oct 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 4, 2026 •

edited

Loading

Uh oh!

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading

Review limit reached

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 4, 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 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

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

Uh oh!

Uh oh!

github-actions Bot commented Oct 4, 2026

🚀 Changeset Version Preview

🟩 Patch bumps

Uh oh!

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

Uh oh!

Review limit reached

Walkthrough

Changes

Architecture Summary

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026

Uh oh!

github-actions Bot commented Oct 4, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 4, 2026 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented Oct 4, 2026 •

edited

Loading

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading