docs(preact-query): cross-link hooks with their options factories via '@see' and move the infinite-query caveat to '@remarks' by sukvvon · Pull Request #11289 · TanStack/query

sukvvon · 2026-08-25T14:19:14Z

🎯 Changes

Adds TypeDoc @see cross-links between each hook and its options factory, in both directions, for the three pairs that have one: useQuery ↔ queryOptions, useInfiniteQuery ↔ infiniteQueryOptions, and useMutation ↔ mutationOptions. Applied consistently across every overload of each function so the cross-link isn't missing from some overloads and present in others.

Also moves the useInfiniteQuery caveat about imperative fetch calls interfering with the default refetch behavior into a @remarks block, and applies it to all three overloads (previously only the third had it in prose). TypeDoc renders @remarks as its own "Remarks" section, separating incidental caveats from the primary description.

Verified with pnpm run generate-docs that both tags render as expected — @see as a "See" section with a working link to the target page, @remarks as a "Remarks" section — and that pnpm --filter @tanstack/preact-query run test:types still passes.

✅ 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 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
- Improved API documentation for query, mutation, and infinite-query utilities.
- Added cross-references between related hooks and options helpers.
- Added remarks explaining imperative fetching behavior for infinite queries.
- Updated source links to point to the correct implementation locations.
- No runtime behavior or public API changes.

…@see

…@see' and move the infinite-query caveat to '@remarks'

nx-cloud · 2026-08-25T14:19:46Z

View your CI Pipeline Execution ↗ for commit e6dd0cc

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

☁️ Nx Cloud last updated this comment at 2026-08-25 14:26:55 UTC

coderabbitai · 2026-08-25T14:20:40Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 95b0c31a-449f-44b5-a4b2-7ebbf4a1cb84

📥 Commits

Reviewing files that changed from the base of the PR and between 0a16a36 and e6dd0cc.

📒 Files selected for processing (12)

docs/framework/preact/reference/functions/infiniteQueryOptions.md
docs/framework/preact/reference/functions/mutationOptions.md
docs/framework/preact/reference/functions/queryOptions.md
docs/framework/preact/reference/functions/useInfiniteQuery.md
docs/framework/preact/reference/functions/useMutation.md
docs/framework/preact/reference/functions/useQuery.md
packages/preact-query/src/infiniteQueryOptions.ts
packages/preact-query/src/mutationOptions.ts
packages/preact-query/src/queryOptions.ts
packages/preact-query/src/useInfiniteQuery.ts
packages/preact-query/src/useMutation.ts
packages/preact-query/src/useQuery.ts

Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review.

📝 Walkthrough

Walkthrough

The change adds JSDoc cross-references between Preact option helpers and hooks. It adds infinite-query remarks, and updates generated reference pages with matching links and source-line references.

Changes

Preact API documentation

Layer / File(s)	Summary
Source JSDoc cross-references `packages/preact-query/src/Options.ts`, `packages/preact-query/src/use.ts`	Option helpers now link to their related hooks. Infinite-query overloads document imperative fetch remarks and link to `infiniteQueryOptions`.
Generated reference documentation `docs/framework/preact/reference/functions/*`	Reference pages now include matching “See” and “Remarks” sections. `Defined in` links use updated source lines.

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

Merge Risk: ⚪ Minimal · up to e6dd0

This change only improves documentation cross-links and the placement of an infinite-query caveat; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main documentation changes: adding cross-links between hooks and option factories and moving the infinite-query caveat to `@remarks`. It is specific and related to the f…
Description check	✅ Passed	The description includes the required Changes, Checklist, and Release Impact sections. It explains the documentation updates, records validation steps, confirms checklist completion, and identifies th…
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 6…
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.

Full details: Title check

Explanation

The title clearly summarizes the main documentation changes: adding cross-links between hooks and option factories and moving the infinite-query caveat to @remarks. It is specific and related to the full changeset.

Full details: Description check

Explanation

The description includes the required Changes, Checklist, and Release Impact sections. It explains the documentation updates, records validation steps, confirms checklist completion, and identifies the change as docs-only with no release impact.

Full details: Docstring Coverage

Explanation

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 6 files. (6 skipped: 6 unsupported.)

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/preact-query-see-remarks

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

github-actions · 2026-08-25T14:20:52Z

🚀 Changeset Version Preview

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

pkg-pr-new · 2026-08-25T14:22:08Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: e6dd0cc

github-actions · 2026-08-25T14:22:29Z

size-limit report 📦

Path	Size
react full	11.97 KB (0%)
react minimal	8.92 KB (0%)

docs(preact-query): cross-link hooks with their options factories via '…

e6dd0cc

…@see' and move the infinite-query caveat to '@remarks'

sukvvon self-assigned this Aug 25, 2026

sukvvon merged commit e6503b0 into main Aug 25, 2026
9 checks passed

sukvvon deleted the docs/preact-query-see-remarks branch August 25, 2026 14:28

Navigation Menu

Uh oh!

Uh oh!

docs(preact-query): cross-link hooks with their options factories via '@see' and move the infinite-query caveat to '@remarks' - #11289

docs(preact-query): cross-link hooks with their options factories via '@see' and move the infinite-query caveat to '@remarks'#11289
sukvvon merged 1 commit into
mainfrom
docs/preact-query-see-remarks

sukvvon commented Aug 25, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

nx-cloud Bot commented Aug 25, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 25, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

github-actions Bot commented Aug 25, 2026

Uh oh!

pkg-pr-new Bot commented Aug 25, 2026

Uh oh!

github-actions Bot commented Aug 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Uh oh!

Conversation

sukvvon commented Aug 25, 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!

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

Uh oh!

Uh oh!

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

Uh oh!

Walkthrough

Changes

Uh oh!

github-actions Bot commented Aug 25, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Aug 25, 2026

Uh oh!

github-actions Bot commented Aug 25, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Aug 25, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Aug 25, 2026 •

edited

Loading

coderabbitai Bot commented Aug 25, 2026 •

edited

Loading