Wonsuk Choi
ba341f5a07
docs(react-query): add missing JSDoc to react-query, react-query-next-experimental, and react-query-devtools ( #11843 )
...
* docs(react-query): add missing JSDoc to react-query, react-query-next-experimental, and react-query-devtools
* docs(react-query-next-experimental): correct where streamed hydration and HTML insertion happen
2026-10-04 04:15:50 +09:00
Wonsuk Choi
4bb041f4d9
docs(query-core): add missing JSDoc to mutation, retryer, managers, and infinite query behavior ( #11838 )
...
* docs(query-core): add missing JSDoc to mutation, retryer, managers, and infinite query behavior
* docs(query-core/mutation): note that 'continue' rejects when the resumed mutation fails
* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:57:33 +09:00
Wonsuk Choi
ffa2a29b35
docs(query-core/{infiniteQueryObserver,mutationObserver,queriesObserver}): add missing JSDoc to observer methods ( #11837 )
...
* docs(query-core/{infiniteQueryObserver,mutationObserver,queriesObserver}): add missing JSDoc to observer methods
* docs(query-core/infiniteQueryObserver): note that 'cancelRefetch: false' can reuse a running fetch in the page fetch return values
* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:56:34 +09:00
Wonsuk Choi
7a3ab9f36e
docs(query-core/timeoutManager): add missing JSDoc to 'TimeoutManager' methods and escape '@tanstack/query-core' ( #11836 )
...
* docs(query-core/timeoutManager): add missing JSDoc to 'TimeoutManager' methods and escape '@tanstack/query-core'
* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:55:40 +09:00
Wonsuk Choi
bb2d79a6e2
docs(query-core/hydration): add missing JSDoc to dehydration and hydration functions ( #11835 )
...
* docs(query-core/hydration): add missing JSDoc to dehydration and hydration functions
* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:54:47 +09:00
Wonsuk Choi
4ab74a72cf
docs(query-core/queryCache): add missing JSDoc to 'QueryCache' methods ( #11834 )
2026-10-04 02:53:45 +09:00
Wonsuk Choi
7883ad1102
docs(query-core/mutationCache): add missing JSDoc to 'MutationCache' methods ( #11833 )
2026-10-04 02:52:54 +09:00
Wonsuk Choi
68e670e1f5
docs(query-core/queryObserver): add missing JSDoc to 'QueryObserver' methods and fetch helpers ( #11832 )
2026-10-04 02:50:25 +09:00
Wonsuk Choi
7dd8803117
docs(query-core/query): add missing JSDoc to 'Query' members and state helpers ( #11831 )
...
* docs(query-core/query): add missing JSDoc to 'Query' members and state helpers
* docs(query-core/query): qualify the 'isStaleByTime' and 'fetch' parameter and return descriptions
2026-10-04 02:48:18 +09:00
Wonsuk Choi
6e16d3946a
docs(query-core/utils): add missing JSDoc to utility functions ( #11830 )
...
* docs(query-core/utils): add missing JSDoc to utility functions
* docs(query-core/utils): clarify that 'addToEnd' and 'addToStart' drop at most one item
* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:47:14 +09:00
Wonsuk Choi
ad9a67c0ee
docs(query-core/queryClient): add missing JSDoc '@param' and '@returns' to 'QueryClient' methods ( #11829 )
...
* docs(query-core/queryClient): add missing JSDoc '@param' and '@returns' to 'QueryClient' methods
* docs(query-core/queryClient): describe 'select' in the return values of 'query' and 'infiniteQuery'
2026-10-04 02:43:31 +09:00
Wonsuk Choi
57db962344
docs(*): fix JSDoc '@param' names that don't match the parameters and enforce 'jsdoc/check-param-names' ( #11828 )
...
* docs(*): fix JSDoc '@param' names that don't match the parameters
* chore(eslint.config): raise 'jsdoc/check-param-names' to error without requiring destructured properties
2026-10-04 01:57:41 +09:00
autofix-ci[bot]
bf3a04c21c
ci: apply automated fixes
2026-09-25 05:17:34 +00:00
Wonsuk Choi
848b42129e
docs({react,preact,solid,vue}-query/useQuery): add 'initialDataUpdatedAt' to the seeding example ( #11579 )
2026-09-23 13:36:10 +09:00
Wonsuk Choi
10a5afcafb
docs(*): exclude protected members from generated reference docs ( #11564 )
2026-09-23 13:32:45 +09:00
Wonsuk Choi
d33b407d2a
docs({react,preact}-query): correct 'initialData'/'select' and 'QueriesOptions' fallback JSDoc inaccuracies ( #11574 )
...
* docs(react-query): correct inaccurate JSDoc statements
* docs(react-query): split QueriesOptions/SuspenseQueriesOptions JSDoc into paragraphs
* docs(preact-query): correct 'initialData'/'select' and 'QueriesOptions' fallback JSDoc inaccuracies
* docs({react,preact}-query): fix missed 'select' qualifier on 'DefinedInitialDataOptions' JSDoc
2026-09-23 12:19:55 +09:00
Wonsuk Choi
baf7cc644b
docs(query-core): add JSDoc '@param' for 'QueryClient#setQueryData' options ( #11571 )
2026-09-22 11:27:13 +09:00
Wonsuk Choi
87c77175f9
docs(query-core): remove dead '@param' tags from 'streamedQuery' ( #11570 )
2026-09-22 11:25:53 +09:00
Wonsuk Choi
b5553313ba
docs(query-core): add JSDoc '@returns' for 'QueryClient' data accessors ( #11569 )
2026-09-22 11:17:08 +09:00
Wonsuk Choi
46b22a636f
docs(query-core): add JSDoc for 'Subscribable' and 'Removable' base classes ( #11565 )
2026-09-22 10:50:43 +09:00
Wonsuk Choi
64f1795ada
docs(query-core): add JSDoc for 'select' and 'defaultOptions' ( #11562 )
2026-09-21 11:25:46 +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
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
1a51bb80bf
docs(*): clarify 'Promise.all' only waits for all mutateAsync calls when they succeed ( #11435 )
2026-09-07 00:31:27 +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
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
Ciarán Curley
40321a0b1b
docs: add docs for simplified query methods ( #10662 )
...
docs: add docs for simplfied impertive query methods
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-08-22 21:04:36 +02:00
Ciarán Curley
e6748265c8
React: update usePrefetchQuery to use new methods, plus react adaptor tests and docs ( #10668 )
...
* feat(react-query): update usePrefetchQuery to use new imperitive methods plus tests
* docs(react-query): new docs for usePrefetchQuery
* Update .changeset/warm-candies-like.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
* Update packages/react-query/src/usePrefetchInfiniteQuery.tsx
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
* Update packages/react-query/src/usePrefetchQuery.tsx
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
---------
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-08-20 18:35:32 +02:00
Dominik Dorfmeister 🔮
1ef42087c9
ref: remove experimental_prefetchInRender ( #11221 )
2026-08-20 11:32:10 +02:00
Wonsuk Choi
6423f9eb9e
docs(vue-query/reference): hide React-only 'React.use()' mention from useInfiniteQuery ( #11203 )
2026-08-17 04:24:43 +09:00
Wonsuk Choi
b36374c150
docs(react-query/reference): fix 'queryClient' nesting in 'HydrationBoundary' options ( #11201 )
2026-08-17 02:45:36 +09:00
Wonsuk Choi
4ace03b55a
docs(react-query/reference): remove stale 'suspense' references left over from the v5 suspense split ( #11200 )
2026-08-17 02:44:07 +09:00
Wonsuk Choi
159982c80b
docs(react-query/useQuery): document 'throwOnError' default value ( #11156 )
...
* docs(react-query/useQuery): document 'throwOnError' default and its absence in suspense hooks
* docs(react-query/useQuery): use framework-agnostic wording for suspense throwOnError note
* docs(react-query/useQuery): remove inaccurate suspense-mode throwOnError note
2026-08-12 10:03:07 +09:00
Samuel Wai Weng Yong
f6cf12002a
docs({react,solid}-query): add missing 'errorUpdateCount' to 'useQuery' return signature ( #11041 )
...
* docs(react-query): add missing errorUpdateCount to useQuery return signature
* docs(react-query): move errorUpdateCount after errorUpdatedAt
* docs(react-query): keep 'errorUpdateCount' before 'errorUpdatedAt' to preserve alphabetical order
---------
Co-authored-by: Wonsuk Choi <sukvvon@gmail.com>
2026-07-13 03:28:00 +09:00
Jonghyeon Ko
1f84256a2e
docs: document the select typing caveat for parallel-queries hooks ( #10984 )
...
Inlining a `select` on a query object passed to `useQueries` /
`useSuspenseQueries` can't infer its `data` argument from the sibling
`queryFn` and falls back to `unknown` — a known TypeScript limitation
(TanStack/query#6556 ).
Document the two workarounds (annotate the `select` parameter, or define
the query with the `queryOptions` helper) in the React docs, and add type
tests guarding the behavior. Scoped to React for an easier review; the
other framework adapters can follow the same pattern in separate PRs.
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-27 15:30:15 +02:00
Dominik Dorfmeister 🔮
6540a4126b
feat(core): callback for retryOnMount ( #10515 )
...
* feat(core): callback for retryOnMount
* ci: apply automated fixes
* fix: vue
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-23 14:45:49 +02:00
Daniel Bondarenko
4e8be3f46f
docs: clarify that failureCount starts at 0 in retry callback ( #10031 )
...
Added clarification that failureCount parameter in the retry callback
function starts at 0 for the first retry attempt, not 1.
Fixes #10017
2026-01-16 11:24:55 +01:00
Talgat Minigaliev
bdec357b9e
docs: Modify onMutate signature to add context parameter ( #9982 )
...
Updated the onMutate function signature to include context.
2025-12-27 12:31:21 +01:00
Lachlan Collins
5ad78fc4ad
docs: correct local relative links ( #9947 )
...
* docs: correct local relative links
* Update links
* Slight tweaks
* String
2025-12-05 22:39:25 +11:00
Sarah
7783a7ae49
docs: add community resources page ( #9831 )
...
* add community resources page
* update link for blog posts
* update community resource links
* rm vue community section
* update old links
* fix community resource link
2025-11-06 12:59:56 +01:00
Josh
a2151d28e1
feat(query-core): add context to mutationfn & mutation callbacks ( #9615 )
...
* feat(query-core): add context to mutationfn
Co-Authored-By: travikk <627275+travikk@users.noreply.github.com>
* fix(query-core): mutation onSuccess scope param should also be undefined
Co-Authored-By: travikk <627275+travikk@users.noreply.github.com>
* feat: add scope deprecate context on mutation state
* feat(query-core): add mutation context to all mutation callbacks
* chore: pr amends
Co-Authored-By: Dominik Dorfmeister <1021430+TkDodo@users.noreply.github.com>
* test(unit): update to handle context in mutation callbacks
* chore: rename to onMutateResult
* chore: revert context deprecation on MutationState
---------
Co-authored-by: travikk <627275+travikk@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister <1021430+TkDodo@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2025-09-16 10:22:43 +02:00