autofix-ci[bot]
b74c5f61ef
ci: apply automated fixes
2026-10-26 10:19:26 +00:00
Wonsuk Choi
14cc3302e3
style(packages): write durations in 'count * unit * 1000' order ( #12382 )
...
* style(packages): write durations in 'count * unit * 1000' order
* docs(framework/*/reference): regenerate 'Query' reference for the 'isStaleByTime' example
2026-10-26 02:30:25 +09:00
Wonsuk Choi
650c69abcd
docs(framework): write snippet durations in 'count * unit * 1000' order ( #12381 )
2026-10-26 02:26:34 +09:00
Wonsuk Choi
bd816358c9
docs(framework): replace numeric separators with 'N * 1000' in snippet durations ( #12380 )
2026-10-26 02:19:46 +09:00
Wonsuk Choi
db81416812
docs(*): use American spellings 'behavior', 'initialized', and 'optimize', and 'falsy' instead of 'falsey' ( #12348 )
2026-10-25 21:27:53 +09:00
Wonsuk Choi
a5d5e00458
docs(*-devtools): describe how the 'theme' prop interacts with the theme selected in the devtools Settings menu ( #12314 )
2026-10-24 02:53:19 +09:00
Wonsuk Choi
56432b4a22
docs: use 'sh' instead of 'bash' for the shell code blocks ( #12207 )
2026-10-20 17:21:27 +09:00
Wonsuk Choi
21654f27bd
docs(react/guides/testing): install '@testing-library/react' instead of the React 17 hooks library and remove the dangling 'waitFor' notes ( #12204 )
2026-10-20 16:04:18 +09:00
Wonsuk Choi
5178ad4b1a
docs(react/guides/testing): fix the 'nock' chain order and the 'data.pages' assertions in the infinite query example ( #12200 )
2026-10-20 15:26:34 +09:00
Wonsuk Choi
5b6042cef9
docs(*): document the 'hideDisabledQueries' devtools option and its 'false' default ( #12155 )
2026-10-20 03:49:02 +09:00
autofix-ci[bot]
8c3f218b13
ci: apply automated fixes
2026-10-19 10:58:53 +00:00
Dominik Dorfmeister 🔮
1f8d134ea3
fix(react, preact): recompute mutation state snapshots ( #12117 )
...
* fix(react-query): recompute mutation state snapshots
* test(react-query): assert visible mutation counts
* fix(react-query): preserve mutation result references across renders
* fix(react-query): cache snapshots for non-plain selector results
* fix(preact-query): recompute mutation state snapshots
* Apply suggestion from @TkDodo
* fix: remove useMemo
2026-10-19 12:57:16 +02:00
Wonsuk Choi
68b655af86
docs({react,preact}/quick-start): use 'createRoot' in the React example and keep 'render' from 'preact' in the Preact example ( #12080 )
2026-10-18 22:27:47 +09:00
Wonsuk Choi
116687942b
docs(react/guides/ssr): add the default 'staleTime' to the 'Remove boilerplate' '_app' example ( #12079 )
2026-10-18 22:27:40 +09:00
Wonsuk Choi
ccbd483363
docs(react/guides/mutations): use 'createAsyncStoragePersister' instead of the deprecated 'createSyncStoragePersister' ( #12078 )
2026-10-18 22:27:33 +09:00
autofix-ci[bot]
1099ebb444
ci: apply automated fixes
2026-10-17 17:55:17 +00:00
Wonsuk Choi
ec80fda0c1
docs(framework/react/overview): throw on a non-ok 'fetch' response in the example, and in 'examples/react/simple' ( #12057 )
2026-10-17 18:03:41 +02:00
Wonsuk Choi
f38e6271b4
chore(*): update '@tanstack/typedoc-config' to v0.3.5 ( #12035 )
...
* chore(scripts/generate-docs): read type alias bodies whose type parameters have defaults
* chore(*): update '@tanstack/typedoc-config' to v0.3.5
2026-10-17 11:14:03 +09:00
autofix-ci[bot]
acd8bbc984
ci: apply automated fixes
2026-10-15 07:39:46 +00:00
Wonsuk Choi
27346620ad
docs(*): exclude members declared in 'node_modules' from generated reference docs ( #12014 )
2026-10-15 10:09:02 +09:00
autofix-ci[bot]
6dc69dd265
ci: apply automated fixes
2026-10-12 12:14:45 +00:00
Dominik Dorfmeister 🔮
e22e7c4a27
chore: test TypeScript 7.1 preview and drop 5.6 ( #11947 )
...
* chore: test TypeScript 7.1 preview and drop 5.6
* chore: use a mature TypeScript 7.1 preview
2026-10-10 16:26:58 +02:00
autofix-ci[bot]
6a9a04f9bb
ci: apply automated fixes
2026-10-09 15:50:46 +00:00
Wonsuk Choi
d169ee8778
docs(*): add property tables and overload overviews to reference pages and keep declared alias names ( #11758 )
...
* docs(*): add parameter and result property tables to reference function pages and an overview to overloaded ones
* docs(*): link to the base type's properties when a parameter or result type has no property table
* docs(framework/*/reference): regenerate reference docs
* docs(framework/*/reference): regenerate reference docs
* chore(scripts/generate-docs): restore the 'dirname' import that the merge dropped
* docs(framework/*/reference): regenerate reference docs
* docs(scripts/generate-docs): label overloads in the overview with their declared parameter and return types
* docs(framework/*/reference): regenerate reference docs
* docs(scripts/generate-docs): convert declared intersection types from the source so signatures keep their alias names
* docs(framework/*/reference): regenerate reference docs
* docs(scripts/generate-docs): reword a comment to avoid the unknown word 'inlines'
* docs(scripts/generate-docs): skip a parameter table on overloaded pages when its heading is missing
2026-10-06 02:38:27 +09:00
Wonsuk Choi
1d2cf91305
chore(*): update '@tanstack/typedoc-config' to v0.3.4 ( #11817 )
...
* chore(*): update '@tanstack/typedoc-config' to v0.3.4 and load its custom settings plugin by package export
* docs(framework/*/reference): regenerate reference docs with '@tanstack/typedoc-config' v0.3.4
* docs(framework/*/reference): regenerate reference docs
* docs(framework/*/reference): regenerate reference docs
2026-10-05 12:41:28 +09:00
Wonsuk Choi
9dd4d7d506
docs(query-core/types): add JSDoc to the properties of the exported interfaces and type aliases ( #11891 )
...
* docs(query-core/types): add JSDoc to the properties of the exported interfaces and type aliases
* docs(query-core/types): mention mutations in the 'hydrate' default options description
2026-10-05 01:55:45 +09:00
Wonsuk Choi
0012ec14c3
docs(react-query): add JSDoc to the properties of the exported interfaces and type aliases ( #11894 )
2026-10-05 01:49:55 +09:00
Wonsuk Choi
9962ee1fe2
docs(query-core): add JSDoc to the properties of the exported interfaces and type aliases outside 'types.ts' ( #11892 )
2026-10-05 01:48:47 +09:00
Wonsuk Choi
c0f20a8259
docs(query-core): add JSDoc to the base methods of the exported classes ( #11878 )
2026-10-04 12:30:05 +09:00
Wonsuk Choi
01abab33f8
docs(*): note that 'throwOnError' makes the hook rethrow the errors of 'mutate' ( #11877 )
...
* docs(*): note that 'throwOnError' makes the hook rethrow the errors of 'mutate'
* docs(angular-query-experimental/types): mention that 'injectMutation' emits the error on 'ngZone.onError' before rethrowing it
2026-10-04 12:29:23 +09:00
Wonsuk Choi
5a8fa03f9a
docs(query-core/types): add JSDoc to the exported interfaces and type aliases ( #11865 )
2026-10-04 11:52:31 +09:00
Wonsuk Choi
b42166e557
docs(react-query): add JSDoc to the exported interfaces and type aliases ( #11868 )
2026-10-04 11:41:22 +09:00
Wonsuk Choi
c1d297e99c
docs(query-core): add JSDoc to the exported interfaces and type aliases outside 'types.ts' ( #11866 )
2026-10-04 11:40:07 +09:00
Wonsuk Choi
0362347c5c
docs(query-core/queryClient): correct the merge order described for 'defaultQueryOptions' and 'defaultMutationOptions' ( #11861 )
2026-10-04 05:20:23 +09:00
Wonsuk Choi
205d422412
docs(*): add missing JSDoc descriptions and enforce 'jsdoc/require-description' ( #11860 )
...
* docs(*): add missing JSDoc descriptions
* chore(eslint.config): enforce 'jsdoc/require-description'
2026-10-04 05:16:10 +09:00
Wonsuk Choi
cbdb21468a
docs(*): replace JSDoc descriptions that only repeat the names and enforce 'jsdoc/informative-docs' ( #11859 )
...
* docs(*): replace JSDoc descriptions that only repeat the names
* chore(eslint.config): enforce 'jsdoc/informative-docs'
2026-10-04 05:08:09 +09:00
Wonsuk Choi
0b9949acb9
docs(*): sort JSDoc tags and enforce 'jsdoc/sort-tags' ( #11858 )
...
* docs(*): sort JSDoc tags
* chore(eslint.config): enforce 'jsdoc/sort-tags'
2026-10-04 05:03:01 +09:00
Wonsuk Choi
edc38e2d17
docs(framework/*/reference): regenerate reference docs ( #11857 )
2026-10-04 04:55:10 +09:00
Wonsuk Choi
cada88ab41
docs(*): add missing JSDoc '@throws' tags and enforce 'jsdoc/require-throws' ( #11856 )
...
* docs(*): add missing JSDoc '@throws' tags
* chore(eslint.config): enforce 'jsdoc/require-throws'
2026-10-04 04:52:09 +09:00
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