docs(preact-query): tag 'subscribed' with '@defaultValue' for structured default-value rendering

[sukvvon]

🎯 Changes

Tags the subscribed option's default with TypeDoc's @defaultValue tag, in the three places it's declared (UseBaseQueryOptions, UseInfiniteQueryOptions, and the inline useQueries per-query options).

Previously the default was only mentioned as prose inside the description ("Defaults to true."). TypeDoc renders @defaultValue as a separate, structured "Default Value" section, so this makes the default visually distinct from the description instead of buried in it. Verified with pnpm run generate-docs — the rest of the diff in docs/framework/preact/reference/ is line-number drift in Defined in: links from the added JSDoc lines, not content changes.

✅ 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 documentation for the subscribed option by clearly displaying its default value as true.
  • Updated source-reference links throughout the Preact API reference to keep them accurate and current.

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 6e0f780

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

---

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

[coderabbitai]

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: f01f60b0-a4e5-4f0c-a392-2fbe8ebef3ab

📥 Commits

Reviewing files that changed from the base of the PR and between 84b4f13 and 6e0f780.

📒 Files selected for processing (27)

• docs/framework/preact/reference/functions/useQueries.md
• docs/framework/preact/reference/interfaces/UseBaseQueryOptions.md
• docs/framework/preact/reference/interfaces/UseInfiniteQueryOptions.md
• docs/framework/preact/reference/interfaces/UseMutationOptions.md
• docs/framework/preact/reference/interfaces/UseQueryOptions.md
• docs/framework/preact/reference/interfaces/UseSuspenseInfiniteQueryOptions.md
• docs/framework/preact/reference/interfaces/UseSuspenseQueryOptions.md
• docs/framework/preact/reference/type-aliases/AnyUseInfiniteQueryOptions.md
• docs/framework/preact/reference/type-aliases/AnyUseMutationOptions.md
• docs/framework/preact/reference/type-aliases/AnyUseQueryOptions.md
• docs/framework/preact/reference/type-aliases/AnyUseSuspenseInfiniteQueryOptions.md
• docs/framework/preact/reference/type-aliases/AnyUseSuspenseQueryOptions.md
• docs/framework/preact/reference/type-aliases/DefinedUseInfiniteQueryResult.md
• docs/framework/preact/reference/type-aliases/DefinedUseQueryResult.md
• docs/framework/preact/reference/type-aliases/UseBaseMutationResult.md
• docs/framework/preact/reference/type-aliases/UseBaseQueryResult.md
• docs/framework/preact/reference/type-aliases/UseInfiniteQueryResult.md
• docs/framework/preact/reference/type-aliases/UseMutateAsyncFunction.md
• docs/framework/preact/reference/type-aliases/UseMutateFunction.md
• docs/framework/preact/reference/type-aliases/UseMutationResult.md
• docs/framework/preact/reference/type-aliases/UsePrefetchInfiniteQueryOptions.md
• docs/framework/preact/reference/type-aliases/UsePrefetchQueryOptions.md
• docs/framework/preact/reference/type-aliases/UseQueryResult.md
• docs/framework/preact/reference/type-aliases/UseSuspenseInfiniteQueryResult.md
• docs/framework/preact/reference/type-aliases/UseSuspenseQueryResult.md
• packages/preact-query/src/types.ts
• packages/preact-query/src/useQueries.ts

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

---

📝 Walkthrough

Walkthrough

The change updates Preact query documentation. Source comments now use @defaultValue true. Generated reference pages show dedicated default-value sections and current source line links. No runtime or public type behavior changed.

Changes

Preact documentation updates

Layer / File(s)	Summary
Update source documentation annotations packages/preact-query/src/types.ts, packages/preact-query/src/useQueries.ts	The subscribed option documentation now uses explicit default-value annotations or sections showing true.
Synchronize generated reference pages docs/framework/preact/reference/...	Generated Preact reference pages now use dedicated default-value sections and updated preact-query/src/types.ts source links.

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

Merge Risk: ⚪ Minimal · up to 6e0f7

This change improves how the existing subscribed default is displayed in Preact Query documentation without changing published runtime behavior; 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 and concisely describes the main change: adding TypeDoc's @defaultValue tag to the subscribed option in preact-query documentation.
Description check	✅ Passed	The description explains the change and motivation, identifies the affected declarations, documents verification with pnpm run generate-docs, completes the checklist, and correctly marks the change as…
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (25 skipped: 2…
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: Description check

Explanation

The description explains the change and motivation, identifies the affected declarations, documents verification with pnpm run generate-docs, completes the checklist, and correctly marks the change as documentation-only with no release impact.

Full details: Docstring Coverage

Explanation

Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (25 skipped: 25 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-default-value

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[github-actions]

🚀 Changeset Version Preview

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

[pkg-pr-new]

More templates

• @tanstack/query-example-angular-auto-refetching
• @tanstack/query-example-angular-basic
• @tanstack/query-example-angular-basic-persister
• @tanstack/query-example-angular-devtools-panel
• @tanstack/query-example-angular-infinite-query-with-max-pages
• @tanstack/query-example-angular-optimistic-updates
• @tanstack/query-example-angular-pagination
• @tanstack/query-example-angular-query-options-from-a-service
• @tanstack/query-example-angular-router
• @tanstack/query-example-angular-rxjs
• @tanstack/query-example-angular-simple
• @tanstack/query-example-lit-basic
• @tanstack/query-example-lit-pagination
• @tanstack/query-example-lit-ssr
• @tanstack/query-example-preact-simple
• @tanstack/query-example-react-algolia
• @tanstack/query-example-react-auto-refetching
• @tanstack/query-example-react-basic
• @tanstack/query-example-react-basic-graphql-request
• @tanstack/query-example-react-batching
• @tanstack/query-example-chat
• @tanstack/query-example-react-default-query-function
• @tanstack/query-example-react-devtools-panel
• @tanstack/query-example-eslint-legacy
• @tanstack/query-example-eslint-plugin-demo
• @tanstack/query-example-react-infinite-query-with-max-pages
• @tanstack/query-example-react-load-more-infinite-scroll
• @tanstack/query-example-react-nextjs
• @tanstack/query-example-react-nextjs-app-optimistic-updates
• @tanstack/query-example-react-nextjs-app-prefetching
• @tanstack/query-example-nextjs-suspense-streaming
• @tanstack/query-example-react-offline
• @tanstack/query-example-react-pagination
• @tanstack/query-example-react-playground
• @tanstack/query-example-react-prefetching
• @tanstack/query-example-react-react-native
• @tanstack/query-example-react-router
• @tanstack/query-example-react-rick-morty
• @tanstack/query-example-react-shadow-dom
• @tanstack/query-example-react-simple
• @tanstack/query-example-react-star-wars
• @tanstack/query-example-react-suspense
• @tanstack/query-example-solid-astro
• @tanstack/query-example-solid-basic
• @tanstack/query-example-solid-basic-graphql-request
• @tanstack/query-example-solid-default-query-function
• @tanstack/query-example-solid-offline
• @tanstack/query-example-solid-simple
• @tanstack/query-example-solid-start-streaming
• @tanstack/query-example-svelte-auto-refetching
• @tanstack/query-example-svelte-basic
• @tanstack/query-example-svelte-load-more-infinite-scroll
• @tanstack/query-example-svelte-optimistic-updates
• @tanstack/query-example-svelte-playground
• @tanstack/query-example-svelte-simple
• @tanstack/query-example-svelte-ssr
• @tanstack/query-example-svelte-star-wars
• @tanstack/query-example-vue-2.6-basic
• @tanstack/query-example-vue-2.7-basic
• @tanstack/query-example-vue-basic
• @tanstack/query-example-vue-dependent-queries
• @tanstack/query-example-vue-nuxt3
• @tanstack/query-example-vue-persister
• @tanstack/query-example-vue-simple

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 6e0f780

[github-actions]

size-limit report 📦

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