Wonsuk Choi
94de9b4e31
docs(svelte-query): call 'useIsMutating' a function instead of a hook ( #11559 )
2026-09-21 10:16:49 +09:00
Wonsuk Choi
47f27a4824
docs(svelte-query): add summaries to reference pages that render without a description ( #11553 )
2026-09-21 02:05:42 +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
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
85de9c35ac
docs(svelte-query): regenerate reference docs to fix stale source line numbers ( #11399 )
2026-09-05 13:43:50 +09:00
Wonsuk Choi
f6ae1ccdf7
feat(svelte-query): add 'DefinedInitialDataInfiniteOptions' overload for 'createInfiniteQuery'/'infiniteQueryOptions' ( #11356 )
...
* feat(svelte-query): add 'DefinedInitialDataInfiniteOptions' overload for 'createInfiniteQuery'/'infiniteQueryOptions'
* chore(.changeset): use conventional commits pattern for changeset entry
* ci: apply automated fixes
* docs(svelte-query): regenerate reference docs for infinite-query initialData overload and update changeset entry
* docs(svelte-query): regenerate reference docs after merging main's JSDoc examples
* docs(svelte-query): revert unrelated line-number-only doc diffs
* docs(svelte-query): drop generated reference doc changes from this type-only PR
* chore(.changeset): match changeset entry to the PR title/commit subject
* docs(svelte-query): regenerate reference docs for the new infinite-query overloads
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-09-01 21:59:20 +09:00
Wonsuk Choi
dd9216c92a
docs(svelte-query): add JSDoc '@example's across hooks and options factories ( #11352 )
...
* docs(svelte-query): add JSDoc '@example's across hooks and options factories
* docs(svelte-query): add missing 'isPending' idiom and 'mutateAsync' examples
* docs(svelte-query): address CodeRabbit review feedback on JSDoc examples
* docs(svelte-query): correct 'pending' status description in createQuery's @returns
* docs(svelte-query): add missing 'initialData' example to infiniteQueryOptions
2026-09-01 21:07:52 +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
Wonsuk Choi
b2dfe4f4e3
feat(svelte-query): add 'mutationOptions' ( #10175 )
...
* feat(svelte-query/mutationOptions): add 'mutationOptions' identity function for type-safe mutation configuration
* test(svelte-query/mutationOptions): add type and runtime tests for 'mutationOptions'
* docs(svelte-query/mutationOptions): add reference documentation for 'mutationOptions'
* chore(svelte-query): add changeset for 'mutationOptions'
* ci: apply automated fixes
* test(svelte-query/mutationOptions): use 'Accessor' type for props in BaseExample and wrap test values with arrow functions
* style(svelte-query/mutationOptions): remove blank lines between 'fireEvent' and assertion blocks
* refactor(svelte-query/mutationOptions): split BaseExample into BaseExample and MultiExample for single and multi mutation tests
* ci: apply automated fixes
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-03-02 08:47:12 +01: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
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
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
Lachlan Collins
144d3a8d90
docs(typedoc): Update output filename ( #7764 )
...
* docs: Update typedoc output filename
* Run prettier
2024-07-19 19:52:50 +10:00
Lachlan Collins
d02e610ff3
docs(typedoc): Add frontmatter ( #7753 )
...
* docs(typedoc): Add frontmatter
* Update knip.json
2024-07-18 15:42:53 +10:00
Lachlan Collins
13817e9537
docs(svelte-query): Auto-generate reference docs ( #7751 )
...
* docs(svelte-query): Auto-generate reference docs
* Fix knip, update exclude
2024-07-18 12:40:19 +10:00