0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
Commit graph

18 commits

Author SHA1 Message Date
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]
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
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
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
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
4ab74a72cf
docs(query-core/queryCache): add missing JSDoc to 'QueryCache' methods (#11834) 2026-10-04 02:53:45 +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
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
46b22a636f
docs(query-core): add JSDoc for 'Subscribable' and 'Removable' base classes (#11565) 2026-09-22 10:50:43 +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
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