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
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
1fd8ecea49
docs(angular-query-experimental): add JSDoc to the properties of the exported interfaces and type aliases ( #11898 )
2026-10-05 01:52:37 +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
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
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
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
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
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
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
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
87c77175f9
docs(query-core): remove dead '@param' tags from 'streamedQuery' ( #11570 )
2026-09-22 11:25:53 +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
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
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
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
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
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
Lachlan Collins
7f4939c624
ci: sync config between projects ( #9931 )
...
* ci: update typedoc
* Remove old check
2025-11-29 19:55:40 +11:00
Arnoud
ddf6b8060b
refactor(angular-query): rename DeveloperToolsFeature to DevtoolsFeature ( #9794 )
2025-10-22 02:24:10 +02: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
Arnoud
e75a5f9d55
feat(angular-query): move devtools to conditional sub-paths ( #9270 )
...
* feat(angular-query-devtools): move devtools to conditional sub-paths, improves tree shaking and dependency injection
* Fix compatibility with moduleResolution node
* ci: apply automated fixes
* fix preview release for angular-query
* Fix angular-query preview release
* Revert some changes made obsolete by better Vite based alternative
* Update export paths
* Fix production exports and publishconfig
* knip config
* remove postpack
* Generate API reference docs
* type declarations in correct directory
* Update documentation
* knip config
* Optional core devtools dependency
* ci: apply automated fixes
* regenerate api reference docs
* ci: apply automated fixes
* ci: apply automated fixes (attempt 2/3)
* regenerate api reference docs
* formatting
* apply coderabbit suggestions
* Improve unit tests
* docs
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-09-16 00:07:53 +02:00
autofix-ci[bot]
20c36c8bf3
ci: apply automated fixes
2025-05-24 06:48:59 +00:00
Tanner Linsley
afc6302dbf
docs: fix links
...
commit 113eb6ba963534fe80b3e96193d767bf769c8bff
Author: Tanner Linsley <tannerlinsley@gmail.com>
Date: Fri May 23 23:16:11 2025 -0600
docs: fix: only transform generated reference
commit d1d084ed9026e31ba746e1bb87d5c19183a7d148
Author: Tanner Linsley <tannerlinsley@gmail.com>
Date: Fri May 23 23:12:07 2025 -0600
docs: fix broken links
commit 0df59ea7d8afb16be86ae917fc46900b6e999351
Author: Tanner Linsley <tannerlinsley@gmail.com>
Date: Fri May 23 15:54:19 2025 -0600
fix: rewrite type doc links to be directory-relative
commit 81e4c71f1c9250005f164b7e585837ee0ad14e23
Author: Tanner Linsley <tannerlinsley@gmail.com>
Date: Fri May 23 15:14:51 2025 -0600
fix: initial fix for ./ => ../
2025-05-24 00:47:55 -06:00
Lachlan Collins
f2fd31853b
docs(typedoc): use sub-folders for reference docs ( #7803 )
2024-07-27 13:03:44 +10:00