docs(preact-query): document functions and components with JSDoc for generated reference docs by sukvvon · Pull Request #11204 · TanStack/query

docs(preact-query): document functions and components with JSDoc for generated reference docs

sukvvon

committed

c069283

docs(preact-query): replace concrete API calls with abstract fetcher names in JSDoc examples

sukvvon

committed

0d88230

docs(preact-query): rename mutation example fetcher to be CRUD-neutral

sukvvon

committed

b0c38c4

docs(preact-query): rename mutation example fetcher to 'createPosts'

sukvvon

committed

2f097ca

docs(preact-query): add examples for Suspense, prefetch, and options-builder functions

sukvvon

committed

f90b7cd

docs(preact-query): add optimistic update, dependent query, and SSR hydration examples

sukvvon

committed

3cd37f2

docs(preact-query): add parameterized factory and mutationKey lookup examples to queryOptions/mutationOptions

sukvvon

committed

ffd159b

docs(preact-query): add infiniteQueryOptions factory example and restore useMutationState's third example

sukvvon

committed

b68477a

docs(preact-query): add TkDodo-inspired multi-API reuse, initialData, and per-call mutate callback examples

sukvvon

committed

9c43e05

docs(preact-query): document useIsRestoring, initialData, mutateAsync, and skipToken-excluded queryFn fields

sukvvon

committed

dcf64a9

docs(preact-query): fill in empty Returns sections for hooks and options builders

sukvvon

committed

a3486e4

docs(preact-query): systematic sweep of generated pages for missing field descriptions and fix mismatched mutationOptions example

sukvvon

committed

b1dae6a

docs(preact-query): split mutationOptions' mutationKey overload into basic usage and lookup examples

sukvvon

committed

ae3438a

docs(preact-query): fix overloads whose example didn't match their initialData-required type

sukvvon

committed

91553e1

docs(preact-query): fill overloads missing examples and useSuspenseQueries' queryClient param description

sukvvon

committed

d653d0c

docs(preact-query): remove duplicated overload example and fix examples that failed type-checking

sukvvon

committed

e0c1281

docs(preact-query): describe every documented parameter and restore reverted overload example

sukvvon

committed

75c6efe

docs(preact-query): describe children props and low-level context exports

sukvvon

committed

47c02aa

fix(preact-query): remove inaccurate 'queryFn is optional' claim from infiniteQueryOptions overload

sukvvon

committed

bfc0475

docs(preact-query): add missing @returns to mutationOptions overloads and provider components

sukvvon

committed

13cf7ba

docs(preact-query): describe QueryErrorResetBoundary children and its render-function parameter

sukvvon

committed

fa95739

docs(preact-query): fix prose-accuracy issues found by multi-agent audit

sukvvon

committed

e30eb05

docs(preact-query): soften remaining overstated queryFn requirement in Suspense options

sukvvon

committed

41143d5

Merge branch 'main' into docs/preact-reference-use-react-ref

sukvvon

authored

d3a0974

docs(preact-query): fix inaccurate prose in hydration, queryFn, and useQueries docs

sukvvon

committed

accd316

docs(preact-query): correct hydration freshness gate, placeholderData arity, and deprecated 'fetchInfiniteQuery' reference

sukvvon

committed

37790c6

docs(preact-query): remove leftover 'data is never undefined' claim in 'useInfiniteQuery' overload docs

sukvvon

committed

da48c99

docs(preact-query): replace deprecated 'prefetchQuery'/'prefetchInfiniteQuery' calls in examples with 'query'/'infiniteQuery'

sukvvon

committed

80e79b0

docs(preact-query): point 'usePrefetchQuery' JSDoc at 'queryClient.query' to match its actual option type

sukvvon

committed

3fd32a1

Merge branch 'main' into docs/preact-reference-use-react-ref

sukvvon

authored

f645835

Navigation Menu

Uh oh!

Uh oh!

docs(preact-query): document functions and components with JSDoc for generated reference docs - #11204

docs(preact-query): document functions and components with JSDoc for generated reference docs#11204
sukvvon wants to merge 30 commits into
mainfrom
docs/preact-reference-use-react-ref

Commits on Aug 24, 2026

docs(preact-query): document functions and components with JSDoc for generated reference docs

docs(preact-query): replace concrete API calls with abstract fetcher names in JSDoc examples

docs(preact-query): rename mutation example fetcher to be CRUD-neutral

docs(preact-query): rename mutation example fetcher to 'createPosts'

docs(preact-query): add examples for Suspense, prefetch, and options-builder functions

docs(preact-query): add optimistic update, dependent query, and SSR hydration examples

docs(preact-query): add parameterized factory and mutationKey lookup examples to queryOptions/mutationOptions

docs(preact-query): add infiniteQueryOptions factory example and restore useMutationState's third example

docs(preact-query): add TkDodo-inspired multi-API reuse, initialData, and per-call mutate callback examples

docs(preact-query): document useIsRestoring, initialData, mutateAsync, and skipToken-excluded queryFn fields

docs(preact-query): fill in empty Returns sections for hooks and options builders

docs(preact-query): systematic sweep of generated pages for missing field descriptions and fix mismatched mutationOptions example

docs(preact-query): split mutationOptions' mutationKey overload into basic usage and lookup examples

docs(preact-query): fix overloads whose example didn't match their initialData-required type

docs(preact-query): fill overloads missing examples and useSuspenseQueries' queryClient param description

docs(preact-query): remove duplicated overload example and fix examples that failed type-checking

docs(preact-query): describe every documented parameter and restore reverted overload example

docs(preact-query): describe children props and low-level context exports

fix(preact-query): remove inaccurate 'queryFn is optional' claim from infiniteQueryOptions overload

docs(preact-query): add missing @returns to mutationOptions overloads and provider components

docs(preact-query): describe QueryErrorResetBoundary children and its render-function parameter

docs(preact-query): fix prose-accuracy issues found by multi-agent audit

docs(preact-query): soften remaining overstated queryFn requirement in Suspense options

Merge branch 'main' into docs/preact-reference-use-react-ref

docs(preact-query): fix inaccurate prose in hydration, queryFn, and useQueries docs

docs(preact-query): correct hydration freshness gate, placeholderData arity, and deprecated 'fetchInfiniteQuery' reference

docs(preact-query): remove leftover 'data is never undefined' claim in 'useInfiniteQuery' overload docs

docs(preact-query): replace deprecated 'prefetchQuery'/'prefetchInfiniteQuery' calls in examples with 'query'/'infiniteQuery'

docs(preact-query): point 'usePrefetchQuery' JSDoc at 'queryClient.query' to match its actual option type

Merge branch 'main' into docs/preact-reference-use-react-ref