Wonsuk Choi
3ecdde1b6f
docs(angular-query-experimental): add JSDoc to the exported interfaces and type aliases ( #11873 )
2026-10-04 11:47:56 +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
4024a9d03f
docs(angular-query-experimental): add missing JSDoc to 'createBaseQuery' and the mutation state helper ( #11845 )
...
* docs(angular-query-experimental): add missing JSDoc to 'createBaseQuery' and the mutation state helper
* docs(angular-query-experimental): note that 'createBaseQuery' keeps functions callable
2026-10-04 04:17:13 +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
10a5afcafb
docs(*): exclude protected members from generated reference docs ( #11564 )
2026-09-23 13:32:45 +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
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
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
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
0c36448862
docs: regenerate TypeDoc reference for angular, svelte, preact, lit ( #11267 )
2026-08-24 10:20:01 +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
Wonsuk Choi
f1a435977f
docs: regenerate reference docs to drop redundant TypeDoc page title heading ( #11196 )
2026-08-16 22:08:19 +09:00
Wonsuk Choi
a9f416bbae
docs: regenerate reference docs to fix stale content and Preact source links ( #11189 )
2026-08-16 17:58:55 +09:00
Melih Arık
31c7f374e2
docs(angular-query): fix invalid imports and syntax error in guide examples ( #11090 )
...
* docs(angular-query): fix three broken examples in the guides
* ci: apply automated fixes
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-08-02 17:34:23 +09:00
Wonsuk Choi
d6798b56b4
docs(angular-query/devtools): add the 'theme' option ( #11002 )
2026-06-29 12:10:31 +09:00
Dmytro Borysov
ad57c81fd3
docs(devtools): make markdown consistent ( #10987 )
...
Currently there is a bug, which prevents proper rendering of the links if there are both MD & HTML syntax in the same line (see https://tanstack.com/query/latest/docs/framework/react/devtools ), probably should be fixed in @tanstack/markdown. Not sure that the source code of this package is published?
In the meantime, I just converted all links to html.
Converting everything (logos) to markdown won't work because we need to set width/height, which can't be done in markdown
2026-06-27 21:50:32 +02:00
Pavan Shinde
bee96b7ca7
docs(angular): fix QueryClient field in paginated guide ( #10147 )
2026-02-26 15:04:59 +01:00