0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
Commit graph

1,248 commits

Author SHA1 Message Date
Wonsuk Choi
94de9b4e31
docs(svelte-query): call 'useIsMutating' a function instead of a hook (#11559) 2026-09-21 10:16:49 +09:00
Wonsuk Choi
73a016baab
docs(solid-query): call the adapter's APIs functions instead of hooks (#11558) 2026-09-21 10:16:36 +09:00
Wonsuk Choi
47f27a4824
docs(svelte-query): add summaries to reference pages that render without a description (#11553) 2026-09-21 02:05:42 +09:00
Wonsuk Choi
3b45ebcadd
docs(solid-query): add summaries to reference pages that render without a description (#11554) 2026-09-21 01:47:02 +09:00
Wonsuk Choi
2a495979b4
docs(query-core): add JSDoc for shared option and registry types (#11552) 2026-09-19 18:08:15 +09:00
Wonsuk Choi
54929cf71f
docs(query-core): add JSDoc for 'initialPageParam' (#11551) 2026-09-19 17:27:33 +09:00
Wonsuk Choi
8f6d322a5a
docs(query-core): add JSDoc for 'MutationOptions' (#11550) 2026-09-19 16:51:40 +09:00
Wonsuk Choi
d346e85f01
docs(*): promote default values from prose to '@defaultValue' tags (#11538) 2026-09-18 17:16:33 +09:00
Wonsuk Choi
992c94234c
docs(query-core): inline option type aliases in generated reference docs (#11534)
* docs(query-core): inline option type aliases in generated reference docs

* docs(query-core): inline retry, notify and remaining option aliases
2026-09-18 17:08:56 +09:00
Wonsuk Choi
e0faf4d594
docs(*): render reference property lists as tables (#11533) 2026-09-18 16:53:17 +09:00
autofix-ci[bot]
bb9d31306f
ci: apply automated fixes 2026-09-18 00:43:18 +00:00
Wonsuk Choi
00059b8796
docs(*): regenerate reference docs to fix stale source links (#11521) 2026-09-17 10:05:02 +09:00
Wonsuk Choi
dcc2215986
docs(*): regenerate reference docs to fix stale source links (#11520) 2026-09-17 09:55:55 +09:00
Ahmet Tınastepe
12027efd5c
fix(vue-query): widen 'queryOptions' input to match 'useQuery' (#11439)
* fix(vue-query): widen 'queryOptions' input to match 'useQuery'

* chore: generate-docs

* chore: changeset

---------

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-09-15 09:00:40 +02:00
chungyoung kim
302345b90a
docs: explain Chrome focus emulation in window focus refetching guide (#11457) 2026-09-14 15:45:16 +02:00
Dami Oyeniyi
27cdf32c97
docs(persister): document asynchronous serialization callbacks (#11411)
Co-authored-by: grzdev <grzdev@users.noreply.github.com>
2026-09-14 15:32:30 +02:00
Dami Oyeniyi
ca0a74e7ae
docs(solid-query): correct devtools development-mode explanation (#11409)
Co-authored-by: grzdev <grzdev@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-09-14 15:32:19 +02:00
Kevin Van Cott
77647e96b5
docs(vue): fix reactivity guide heading hierarchy (#11466) 2026-09-14 15:25:17 +02:00
Tanner Linsley
8c191a966b
docs(react-query): link Start SSR integration guide (#11472) 2026-09-11 17:14:27 -06:00
Wonsuk Choi
87cd8cf855
docs(angular-query-experimental): use descriptive names for remaining generic class fields in guide examples (#11446) 2026-09-08 12:11:39 +09:00
Wonsuk Choi
390de5a8dd
docs(angular-query-experimental): add 'readonly' and use descriptive names for class fields in guide examples (#11445)
* docs(angular-query-experimental): add 'readonly' and use descriptive names for class fields in guide examples

* docs(angular-query-experimental): use descriptive names for class fields in 'placeholder-query-data.md'
2026-09-08 11:39:41 +09:00
Wonsuk Choi
e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* docs(query-core): add JSDoc across the package and expose it in generated reference docs

* docs(config.json): add sidebar entries for newly generated query-core reference docs

* docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc

* docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference

* docs(query-core): regenerate reference docs after merging main

* docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type

* fix(query-devtools): drop unnecessary 'query-core' project reference

* docs(query-core): document missing default values and normalize 'Defaults to' spacing

* docs(query-core): fix 'environmentManager' JSDoc example
2026-09-07 18:22:38 +02:00
Wonsuk Choi
49c7f46506
docs(solid-query/useMutation): add JSDoc examples for optimistic update rollback and parallel 'mutateAsync' calls (#11431)
* docs(solid-query/useMutation): add JSDoc examples for optimistic update rollback and parallel 'mutateAsync' calls

* docs(solid-query/useMutation): clarify 'Promise.all' only waits for all mutateAsync calls when they succeed
2026-09-07 00:52:49 +09:00
Wonsuk Choi
1a51bb80bf
docs(*): clarify 'Promise.all' only waits for all mutateAsync calls when they succeed (#11435) 2026-09-07 00:31:27 +09:00
Peter Budai
aaf4ad94a5
docs(vue-query): skip hydration when Nuxt state is null (#11429)
fix(ssr): ensure hydration only occurs when vueQueryState is not null
2026-09-06 16:55:42 +02:00
Wonsuk Choi
345bb3d372
docs(angular-query-experimental): add 'readonly' to class fields in JSDoc examples (#11416) 2026-09-06 13:03:46 +09:00
Wonsuk Choi
9810709718
docs(angular-query-experimental): add JSDoc across the package (#11406)
* docs(angular-query-experimental): add JSDoc across the package and generate reference docs with TypeDoc

* docs(angular-query-experimental): address CodeRabbit review comments on JSDoc accuracy

* docs(angular-query-experimental): use 'changes' instead of 'narrows' for select's effect on TData
2026-09-06 12:12:24 +09:00
Wonsuk Choi
85de9c35ac
docs(svelte-query): regenerate reference docs to fix stale source line numbers (#11399) 2026-09-05 13:43:50 +09:00
Wonsuk Choi
309508612a
docs(vue-query): add JSDoc and generate reference docs with TypeDoc (#11378)
* docs(vue-query): add JSDoc across the package

* docs(vue-query): generate reference docs with TypeDoc

* docs(config): register vue-query TypeDoc reference pages

* docs(vue-query): preserve dehydrate/hydrate option docs and fix reference links

* docs(config): reorder vue-query reference nav to list 'Functions' first

* docs(config): reorder vue-query 'Functions' entries to match react/preact grouping

* docs(vue-query): restore Suspense guide link and 'placeholderData' behavior note lost in TypeDoc migration

* docs(vue-query): correct JSDoc accuracy issues and reactivity bugs

* docs(vue-query): fix invalidateQueries example that invalidated every query, add whole-options getter example

* docs(vue-query): add examples for the mutationOptions and useInfiniteQuery getter overloads

* docs(vue-query): add react-parity examples for select, skipToken, keepPreviousData, optimistic updates, and infinite scroll

* docs(vue-query): add queryOptions select typing example to useQueries

* docs(vue-query): disconnect IntersectionObserver on unmount, drop non-null assertion in skipToken examples

* docs(vue-query): add 'skipToken' factory example to 'queryOptions'

* docs(vue-query): correct 'queryKey' reactive-getter claim in 'useQuery'/'useInfiniteQuery'

* docs(vue-query): correct 'queryKey' reactive-getter claim in 'QueryOptions' type JSDoc

* docs(vue-query): fix reversed claim that 'queryKey' entries can't be reactive getters
2026-09-05 13:29:11 +09:00
Wonsuk Choi
fc51e96045
docs(react-query, preact-query): use 'button' instead of undefined 'Button' in suspense guide examples (#11390) 2026-09-04 16:00:13 +09:00
Wonsuk Choi
9ea8ea0030
docs(preact-query): fix broken TkDodo link mangled by 'react-query'->'preact-query' replace (#11389) 2026-09-04 16:00:02 +09:00
Jooyoung Shin
ec3f992cbf
docs(preact-query): add 'Suspense' and 'Testing' guides (#11377)
docs(preact-query): add Suspense and Testing guides

The Preact docs had no counterpart for the React "Suspense" and
"Testing" guides even though `@tanstack/preact-query` ships the
suspense hooks and `QueryErrorResetBoundary`.

Follow the existing Preact docs convention: reference the React guide
via `ref:` + `replace:` and override only the React-specific sections
(`preact/compat` Suspense, an error boundary built on `useErrorBoundary`,
`@testing-library/preact`). The React guides only gain the section
markers needed for the overrides; their wording is unchanged.
2026-09-04 15:11:20 +09:00
Wonsuk Choi
b81a6396c6
docs(preact-query): add 'The Query Options API' link, matching react's queryOptions JSDoc (#11388) 2026-09-04 12:04:31 +09:00
Wonsuk Choi
19c96a5134
docs(solid-query): remove 'The Query Options API' link, solid's queryOptions API differs from react's (#11387) 2026-09-04 11:42:55 +09:00
Wonsuk Choi
26e24a07ff
docs(config): reorder solid-query 'Functions' entries to match react grouping (#11386) 2026-09-04 10:26:25 +09:00
Wonsuk Choi
b4f5736437
docs(react-query): fix run-on sentence and subject-verb agreement in SSR guide (#11382) 2026-09-03 23:02:00 +09:00
Wonsuk Choi
d29e7cf0b5
docs(preact-query): fix XSS-unsafe example and missing 'staleTime' in SSR guide (#11381) 2026-09-03 23:00:16 +09:00
Wonsuk Choi
2c5ba585ac
docs(preact-query): add 'Server Rendering & Hydration' guide (#11380)
* docs(preact-query): add 'Server Rendering & Hydration' guide

* docs(preact-query): add 'serializeData'/'deserializeData' to SSR guide
2026-09-03 21:48:01 +09:00
Wonsuk Choi
a29ca68867
docs: redirect flat reference URLs broken by the TypeDoc migration (#11379)
* chore(scripts/generate-docs): inject 'redirect_from' into flat reference URLs

* docs(react-query, solid-query): add 'redirect_from' for URLs broken by the TypeDoc migration
2026-09-03 18:08:28 +09:00
Wonsuk Choi
fe77cdc8d7
docs({react,preact,solid}-query): correct inaccurate JSDoc statements (#11372)
* docs(react-query): correct inaccurate JSDoc statements

* docs(preact-query): correct inaccurate JSDoc statements

* docs({react,preact,solid}-query): stop implying useQueries options are fully identical to useQuery
2026-09-03 10:42:36 +09:00
Wonsuk Choi
de8ab4db3e
docs(solid-query): add JSDoc and generate reference docs with TypeDoc (#11369)
* docs(solid-query): add JSDoc across the package

* docs(solid-query): generate reference docs with TypeDoc

* docs(config): register solid-query TypeDoc reference pages

* docs(solid-query): correct inaccurate JSDoc statements flagged in review
2026-09-03 10:19:23 +09:00
Wonsuk Choi
1a5331a2ab
docs(preact-query): correct inaccurate JSDoc statements (#11367)
* docs(preact-query): correct inaccurate JSDoc statements

* docs(preact-query): regenerate reference docs
2026-09-02 16:25:19 +09:00
Wonsuk Choi
4c568a28c8
docs(react-query): generate reference docs with TypeDoc (#11366)
* docs(vue-query,solid-query): inline react reference content instead of 'ref'-ing hand-written react docs

* docs(react-query): generate reference docs with TypeDoc

* docs(vue-query,solid-query): fix dangling suspense-hook links left over from the react content copy

* docs(solid-query): apply solid's callback call form to inlined reference examples

* docs(react-query): correct inaccurate JSDoc statements flagged in review

* docs(vue-query,solid-query): fix reactivity-aware examples and inaccurate type signatures flagged in review

* docs(vue-query,solid-query): fix remaining type/behavior inaccuracies flagged in second review

* docs(react-query): stop implying a default queryFn defers a fetch the way 'enabled: false' does

* docs(vue-query): mark 'mutate'/'mutateAsync' per-call options as optional
2026-09-02 16:06:54 +09:00
Wonsuk Choi
f6ae1ccdf7
feat(svelte-query): add 'DefinedInitialDataInfiniteOptions' overload for 'createInfiniteQuery'/'infiniteQueryOptions' (#11356)
* feat(svelte-query): add 'DefinedInitialDataInfiniteOptions' overload for 'createInfiniteQuery'/'infiniteQueryOptions'

* chore(.changeset): use conventional commits pattern for changeset entry

* ci: apply automated fixes

* docs(svelte-query): regenerate reference docs for infinite-query initialData overload and update changeset entry

* docs(svelte-query): regenerate reference docs after merging main's JSDoc examples

* docs(svelte-query): revert unrelated line-number-only doc diffs

* docs(svelte-query): drop generated reference doc changes from this type-only PR

* chore(.changeset): match changeset entry to the PR title/commit subject

* docs(svelte-query): regenerate reference docs for the new infinite-query overloads

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-09-01 21:59:20 +09:00
Wonsuk Choi
dd9216c92a
docs(svelte-query): add JSDoc '@example's across hooks and options factories (#11352)
* docs(svelte-query): add JSDoc '@example's across hooks and options factories

* docs(svelte-query): add missing 'isPending' idiom and 'mutateAsync' examples

* docs(svelte-query): address CodeRabbit review feedback on JSDoc examples

* docs(svelte-query): correct 'pending' status description in createQuery's @returns

* docs(svelte-query): add missing 'initialData' example to infiniteQueryOptions
2026-09-01 21:07:52 +09:00
Wonsuk Choi
a85d4f16c9
docs(preact-query): correct 'pending' status description in useQuery's @returns (#11354) 2026-09-01 16:55:30 +09:00
Wonsuk Choi
acf8a3631f
docs(preact-query): rename onError's third example parameter from 'context' to 'onMutateResult' (#11353) 2026-09-01 15:50:46 +09:00
Wonsuk Choi
2b44804d18
docs(preact-query): add 'select' example to 'useQuery' (#11343)
* docs(preact-query): add 'select' example to 'useQuery'

* docs(preact-query): move 'select' example right after the basic 'useQuery' example

* docs(preact-query): make 'select' example derive a different type instead of a subset
2026-08-31 12:29:20 +09:00
Wonsuk Choi
6a732234c7
docs(preact-query): remove hover-prefetch example from 'useQuery'/'useInfiniteQuery' (#11341) 2026-08-31 09:39:25 +09:00
Wonsuk Choi
87fa4c1628
docs(preact-query): define 'App' before 'ErrorBoundary' in 'QueryErrorResetBoundary' example (#11338) 2026-08-31 02:52:42 +09:00