0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
Commit graph

52 commits

Author SHA1 Message Date
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
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
Lucas127128
b8e35598ef
docs(svelte-query/quick-start): Add quick start docs (#11227)
* Add quick start docs in svelte query

* Apply suggestions from code review

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>

* ci: apply automated fixes

---------

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-08-18 21:21:21 +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
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
Poetry Of Code
ac7a42d6a4
docs(svelte): replace deprecated isLoading with isPending in overview (#10990)
`isLoading` is a deprecated alias for `isPending && isFetching` and is
scheduled for removal in the next major version. The overview example
shows a standard (always-enabled) query, so `isPending` is the correct
flag. All other framework overview docs (React, Vue, Angular, Lit,
Preact) already use `isPending`.

Note: `isLoading` is intentionally retained in disabling-queries guides
where it is the right flag for disabled/lazy queries.

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-27 15:40:35 +02:00
Dami Oyeniyi
0d63459555
docs(devtools): correct 'errorTypes' type to array (#10634)
docs(devtools): document errorTypes as array
2026-05-05 12:08:07 +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
7e99b885ff
docs: fix sidebar links (#9933) 2025-11-30 08:08: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
Lachlan Collins
9f82d8e56f
docs(svelte-query): fix diff notation (#9717) 2025-09-30 22:37:49 +10:00
Lachlan Collins
1056ba63b3
feat!(svelte-query): rewrite Svelte adapter to use runes (#9694)
* WIP: Svelte 5 adapter (#6981)

* feat(svelte-query): Improve svelte runes API (#8852)

* feat: Draft proposal

* chore: Improve reactive containers

* ci: apply automated fixes

* oops

* fix: Update API, add a bunch of tests

* merge main

* fix: use const

* more tests

* feat: More tests, back to thunks, fixed svelte-query-persist-client

* feat: More tests and examples!

* lockfile

* fixes

* Fix current CI errors

* More small fixes/tweaks

* Remove test.only

* ci: apply automated fixes

* Fix pnpm-lock, fix import order

* update main docs

* feat: More tests

* ci: apply automated fixes

* add back old tests

* Cleanup

* Fix persist client

* Fix useMutationState

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>

* Use sleep from query-test-utils

* Simplify test reset logic

* Fix some merge conflicts

* More fixes

* A few more fixes

* Fix useMutationState

* Add changeset

* Add migration docs

* Replace Set with SvelteSet

* Update minimum svelte version

* Bump svelte-eslint-parser

* Unwrap createQuery test

* fix(svelte-query): `state_unsafe_mutation` error with `useIs...` (#9493)

* fix(svelte-query): don't wrap observers in derived to avoid state_unsafe_mutation

fixes useIsFetching and useIsMutating in svelte 5 adapter

* test(svelte-query): wrap (useIs...) tests in QueryClientProvider to test non colocated query

* fix(svelte-query): update observers when passed in query client changes

* fix(svelte-query): simplify creatMutation sub/unsub

* Refactor result handling in createMutation.svelte.ts

Replace derived state with direct state and add watchChanges for result updates.

---------

Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>

* chore(svelte-query): fix eslint config (#9699)

* chore(svelte-query): fix eslint config

* Use @typescript-eslint/parser directly

* ci: apply automated fixes

* Fix sherif

* Update docs and changeset

* Update keywords

---------

Co-authored-by: Zhiheng Zhang <55773069+zhihengGet@users.noreply.github.com>
Co-authored-by: Elliott Johnson <sejohnson@torchcloudconsulting.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: David <david@hmnd.io>
2025-09-30 22:07:17 +10:00
Lachlan Collins
89be1895e3
chore: update svelte examples and tests from runes PR 2025-09-26 22:51:17 +10: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
Dmytro Borysov
9a3f68373d
docs: Add not-prose class to browser logo images in devtools documentation (#9556) 2025-08-19 11:59:08 +02:00
Dmytro Borysov
6402d756b7
chore: update browser icons (#9555) 2025-08-11 18:22:20 +02:00
Dmytro Borysov
d25c0da344
docs: Add Firefox and Edge browser extension support to devtools docs (#9548)
- Add browser logos for Chrome, Firefox, and Edge
- Update devtools documentation across all frameworks to include Firefox and Edge extensions
- Replace Chrome-only messaging with multi-browser support
- Add inline browser icons with links to respective extension stores
2025-08-11 13:08:47 +02:00
Dmytro Borysov
1a0ab99943
docs: add Chrome extension information for TanStack Query devtools across multiple frameworks (#9275) 2025-06-19 20:51:01 +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
Nicolai Calinin
c82362ec13
docs(svelte-query): add the devtools page to the svelte-query docs (#8149)
* docs(svelte-query): add the devtools page to the svelte-query docs

* docs(svelte-query): remove the angular stuff, what is skipped

---------

Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
2025-03-07 21:54:04 +11:00
Favour Ohanekwu
322760bf43
docs(framework): update Next.js and Svelte documentation links (#8572)
* docs(svelte): fix writable stores tutorial link

Update the Svelte stores tutorial link to the correct URL in the Svelte Query overview documentation.

The previous link to writable-stores was broken or outdated.

* docs(ssr): update Next.js documentation links to latest version

Update outdated Next.js documentation links in the SSR guide to point to
the latest App Router documentation paths, ensuring users are directed to
the most current and relevant documentation.

Links updated:
- rewrites feature
- automatic static optimization
- rewrite parameters
2025-01-23 17:50:04 +01:00
Shubh Porwal
c7fb5fddc8
docs: fix typos (#7898)
* fix(docs): `instead` typo

* fix(docs): `optimizes` typo

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2024-08-19 14:20:53 +02:00
Jay
3292791219
docs: divided installation scripts (#7881) 2024-08-19 10:36:40 +02: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
Mandeep56Singh
62841b6217
docs(installation):remove prompt symbol from installation commands(#7293) (#7540)
Installation commands for various framework includes prompt symbol.
On execution of same commands IDE throws error
as IDEs by default includes prompt symbol.
This commit resolve this issue
2024-06-10 07:01:06 +02:00
fuko
8fa82653dd
docs: fix broken internal links in the query docs (#7247)
* wip - 1

* Fix more links

* Fix one more link

* Another one

* Update a link

* Fix the broken links in the Angular docs

* Fix the broken links in the Vue docs

* Fix the Svelte links in the docs

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2024-04-22 10:38:13 +02:00
Tanner Linsley
754640a3e5
docs: migrate docs to use path-based navigation instead of route-based (#7211)
TanStack Router uses path-based navigation instead of route-based navigation, so many of the relative documentation links will be invalid after migration. This fixes that.
2024-04-02 16:46:31 -06:00
Ekam Ahuja
d83aa272fb
docs: Updated installation commands with bun package manger (#6971) 2024-02-25 10:15:32 +01:00