docs(preact-query): add JSDoc to the exported interfaces and type aliases by sukvvon · Pull Request #11869 · TanStack/query

sukvvon · 2026-10-03T20:45:25Z

🎯 Changes

Adds a JSDoc description to the exported interfaces and type aliases that didn't have one, written from their definitions and usages:

preact-query-devtools: DevtoolsOptions, DevtoolsPanelOptions
preact-query-persist-client: PersistQueryClientProviderProps
preact-query: QueryErrorResetBoundaryValue

The generated reference docs are regenerated, so these descriptions appear on the type pages (other files only update "Defined in" line numbers).

✅ 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
- Clarified the props and behavior of the Preact devtools, inline devtools panel, persisted-query provider, and query error reset boundary.
- Updated source references for query error reset boundary documentation.

…ases

changeset-bot · 2026-10-03T20:45:31Z

⚠️ No Changeset found

Latest commit: d141a1f

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-03T20:46:15Z

View your CI Pipeline Execution ↗ for commit c111715

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

☁️ Nx Cloud last updated this comment at 2026-10-03 20:51:35 UTC

github-actions · 2026-10-03T20:47:27Z

🚀 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-03T20:47:33Z

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

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: 39b86630-319e-49b2-980e-a7844b8c9df7

📥 Commits

Reviewing files that changed from the base of the PR and between a83ce66 and c111715.

📒 Files selected for processing (9)

docs/framework/preact/reference/functions/QueryErrorResetBoundary.md
docs/framework/preact/reference/functions/useQueryErrorResetBoundary.md
docs/framework/preact/reference/interfaces/QueryErrorResetBoundaryProps.md
docs/framework/preact/reference/type-aliases/QueryErrorResetBoundaryFunction.md
packages/preact-query-devtools/src/PreactQueryDevtools.tsx
packages/preact-query-devtools/src/PreactQueryDevtoolsPanel.tsx
packages/preact-query-devtools/src/index.ts
packages/preact-query-persist-client/src/PersistQueryClientProvider.tsx
packages/preact-query/src/QueryErrorResetBoundary.tsx

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

📝 Walkthrough

Walkthrough

This change adds documentation comments to Preact devtools, persistence, and query error reset APIs. It also updates four QueryErrorResetBoundary reference links to their revised source locations.

Changes

Preact API Documentation

Layer / File(s)	Summary
Document Preact API declarations `packages/preact-query-devtools/src/PreactQueryDevtools.tsx`, `packages/preact-query-devtools/src/PreactQueryDevtoolsPanel.tsx`, `packages/preact-query-devtools/src/index.ts`, `packages/preact-query-persist-client/src/PersistQueryClientProvider.tsx`, `packages/preact-query/src/QueryErrorResetBoundary.tsx`	Added comments describing devtools rendering, panel props, persistence provider props, and the QueryErrorResetBoundary context value.
Update reference source locations `docs/framework/preact/reference/functions/QueryErrorResetBoundary.md`, `docs/framework/preact/reference/functions/useQueryErrorResetBoundary.md`, `docs/framework/preact/reference/interfaces/QueryErrorResetBoundaryProps.md`, `docs/framework/preact/reference/type-aliases/QueryErrorResetBoundaryFunction.md`	Updated the documented source locations for four QueryErrorResetBoundary declarations.

Priority: ⬇️ Low

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

Change: Other

Possibly related PRs

TanStack/query#11204: Adds JSDoc to the Preact QueryErrorResetBoundary API and regenerates its reference docs.

Merge Risk: ⚪ Minimal · up to c1117

This change clarifies existing APIs without changing runtime behavior; no actionable merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to c1117

The change affects 4 systems.

Changed systems: docs, packages/preact-query-devtools, packages/preact-query, packages/preact-query-persist-client

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

observed — docs (service) was modified; 4 changed files map to changed impact.
observed — packages/preact-query-devtools (library) was modified; 3 changed files map to changed impact.
observed — packages/preact-query (library) was modified; 1 changed file maps to changed impact.
observed — packages/preact-query-persist-client (library) was modified; 1 changed file maps to changed impact.

Before / after behavior

observed — Modified behavior in docs/framework/preact/reference/functions/QueryErrorResetBoundary.md: The “Defined in” link now targets line 164 of QueryErrorResetBoundary.tsx instead of line 160.
observed — Modified behavior in docs/framework/preact/reference/functions/useQueryErrorResetBoundary.md: Updated the documented source link for useQueryErrorResetBoundary from line 88 to line 92 of QueryErrorResetBoundary.tsx.
observed — Modified behavior in docs/framework/preact/reference/interfaces/QueryErrorResetBoundaryProps.md: Updated the documented source location for QueryErrorResetBoundaryProps from line 105 to line 109.
observed — Modified behavior in docs/framework/preact/reference/type-aliases/QueryErrorResetBoundaryFunction.md: The “Defined in” link now points to line 102 instead of line 98 in QueryErrorResetBoundary.tsx.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: adding JSDoc to exported Preact Query interfaces and type aliases.
Description check	✅ Passed	The description covers the changes, completes the checklist, and identifies the release impact as docs-only. It follows the required template.
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 5…
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-03T20:47:44Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: c111715

github-actions · 2026-10-03T20:47:55Z

size-limit report 📦

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

docs(preact-query): add JSDoc to the exported interfaces and type ali…

c111715

…ases

sukvvon self-assigned this Oct 3, 2026

Merge branch 'main' into docs/preact-query-jsdoc-types

d141a1f

sukvvon merged commit e0cb6bd into main Oct 4, 2026
7 of 8 checks passed

sukvvon deleted the docs/preact-query-jsdoc-types branch October 4, 2026 02:42

Navigation Menu

Uh oh!

docs(preact-query): add JSDoc to the exported interfaces and type aliases - #11869

docs(preact-query): add JSDoc to the exported interfaces and type aliases#11869
sukvvon merged 2 commits into
mainfrom
docs/preact-query-jsdoc-types

sukvvon commented Oct 3, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 3, 2026 •

edited

Loading

Uh oh!

nx-cloud Bot commented Oct 3, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 3, 2026

Uh oh!

coderabbitai Bot commented Oct 3, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Oct 3, 2026

Uh oh!

github-actions Bot commented Oct 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

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

Uh oh!

Uh oh!

github-actions Bot commented Oct 3, 2026

🚀 Changeset Version Preview

🟩 Patch bumps

Uh oh!

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

Uh oh!

Walkthrough

Changes

Architecture Summary

Uh oh!

pkg-pr-new Bot commented Oct 3, 2026

Uh oh!

github-actions Bot commented Oct 3, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 3, 2026 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented Oct 3, 2026 •

edited

Loading

nx-cloud Bot commented Oct 3, 2026 •

edited

Loading

coderabbitai Bot commented Oct 3, 2026 •

edited

Loading