autofix-ci[bot]
73758917d1
ci: apply automated fixes
2026-11-01 12:51:26 +00:00
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
autofix-ci[bot]
4ed6095096
ci: apply automated fixes
2026-10-23 09:46:30 +00:00
Wonsuk Choi
90e331decc
docs(vue-query/queryClient): add the descriptions of the deprecated 'ensureQueryData', 'fetchQuery', 'prefetchQuery', 'fetchInfiniteQuery', and 'prefetchInfiniteQuery' overrides ( #12212 )
2026-10-20 21:55:40 +09:00
Wonsuk Choi
7b9a85e595
docs(vue-query/queryClient): inherit the descriptions of the first overload on the 'MaybeRefDeep' overloads of 'getQueryData', 'setQueryData', 'query', and 'infiniteQuery' ( #12211 )
2026-10-20 21:50:40 +09:00
autofix-ci[bot]
1099ebb444
ci: apply automated fixes
2026-10-17 17:55:17 +00: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
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
autofix-ci[bot]
6a9a04f9bb
ci: apply automated fixes
2026-10-09 15:50:46 +00: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
866d5429f0
refactor(vue-query): add the 'override' modifier to members that override a base class member ( #11905 )
2026-10-05 03:21:02 +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
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
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
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
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
129955c8fd
docs(vue-query): document 'queryKey'/'mutationKey' getter-entry unwrap gap ( #11573 )
2026-09-22 14:37: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
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
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
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
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
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