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

87 commits

Author SHA1 Message Date
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
64f1795ada
docs(query-core): add JSDoc for 'select' and 'defaultOptions' (#11562) 2026-09-21 11:25:46 +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
87cd8cf855
docs(angular-query-experimental): use descriptive names for remaining generic class fields in guide examples (#11446) 2026-09-08 12:11:39 +09:00
Wonsuk Choi
390de5a8dd
docs(angular-query-experimental): add 'readonly' and use descriptive names for class fields in guide examples (#11445)
* docs(angular-query-experimental): add 'readonly' and use descriptive names for class fields in guide examples

* docs(angular-query-experimental): use descriptive names for class fields in 'placeholder-query-data.md'
2026-09-08 11:39:41 +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
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
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
Melih Arık
31c7f374e2
docs(angular-query): fix invalid imports and syntax error in guide examples (#11090)
* docs(angular-query): fix three broken examples in the guides

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-08-02 17:34:23 +09:00
Wonsuk Choi
d6798b56b4
docs(angular-query/devtools): add the 'theme' option (#11002) 2026-06-29 12:10:31 +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
Pavan Shinde
bee96b7ca7
docs(angular): fix QueryClient field in paginated guide (#10147) 2026-02-26 15:04:59 +01:00
Wonsuk Choi
fef7988924
docs(angular/guides/caching): fix typo 'date' to 'data' (#10189) 2026-02-26 14:54:30 +01:00
Pavan Shinde
c2325ed0fe
docs(angular): fix TypeScript anchor link in mutation options (#10121) 2026-02-12 14:00:53 +01:00
Pavan Shinde
ec60e1c954
docs: angular caching queryfn fix (#10092)
* docs: fix grammar in SSR serialization section

* docs(angular): fix queryFn typo in caching guide

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2026-02-11 09:32:41 +01:00
vedanta
8f0d834382
feat: Preact Adapter (#9935)
* initial setup -- duplicated + package.json edited

* simple preact updations

* missed a React.ReactNode

* testing grunt work (preact library + other small issues + ErrorBoundary custom implementation)

* missed a few

* Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality

* useSuspenseQueries left -- removed the useQuery.promise tests

* forgot the console logs

* useSuspenseQueries 2 resolved; tests done

* ci: apply automated fixes

* fix: example

* fix: configs should be symlinks

* fix: sync versions for npm-run-all2

* ref: re-sync runall2

* ref: go back to 5.0.0

* ref: remove changelog

* react-query -> preact-query

* remove use client directive + added the useSyncExternalStore (decoupled from compat)

* remove the react remnants

* generate docs

* typescript eslint

* docs

* vite config fix

* docs now reference react docs (most of them atleast)

* code-rabbit issues addressed

* <div/> lol

* fix: docs

* ci: apply automated fixes

* fix: lockfile

* fix: duplicated versions

* lockfile (I cooked or am I cooked)

* ci: apply automated fixes

* Making small edits to fix versioning, warnings, and lock

* unhandled error compat

* Fixing CI

* Fixed the CI errors

* ci: apply automated fixes

* Prettier format

* Update changeset for Preact Adapter feature

---------

Co-authored-by: TkDodo <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 12:02:20 +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
autofix-ci[bot]
9ede44d25e
ci: apply automated fixes 2025-11-01 18:15:40 +00:00
Varun
571cf55cf1
docs: fix angular background fetching indicators replace rules (#9819)
docs(angular): add missing replace rules for background-fetching-indicators

- Add replace rules to convert React terminology to Angular equivalents
- Fixes useIsFetching -> injectIsFetching conversion in prose text
- Adds hook -> function terminology conversion
- Includes package name conversion for @tanstack/react-query
- Resolves Issue #9744
2025-11-01 19:14:44 +01:00
Arnoud
ddf6b8060b
refactor(angular-query): rename DeveloperToolsFeature to DevtoolsFeature (#9794) 2025-10-22 02:24:10 +02:00
Arnoud
06e555072b
docs(angular-query): add testing guide (#9669) 2025-09-21 02:38:17 +02:00
Arnoud
3bf9268770
feat(angular-query): integrate with Angular v19+ PendingTasks for whenStable() support (#9666)
Integrates TanStack Query for Angular with Angular's PendingTasks API to properly track
asynchronous operations, ensuring ApplicationRef.whenStable() waits for queries and
mutations to complete before resolving.

Features:
- Cross-version compatibility (Angular v16+ with graceful degradation)
- Tracks query fetchStatus and mutation isPending state
- Automatic cleanup on component destruction
- Comprehensive test coverage including edge cases

Benefits:
- Improved SSR: Server waits for data fetching before rendering
- Better testing: fixture.whenStable() properly waits for async operations
- Zoneless support: Correct change detection timing
2025-09-20 18:46:18 +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
Arnoud
e3b40d4d0d
chore(angular-query): remove standalone component markers as it's now the default (#9647) 2025-09-12 15:09:42 +02:00
Arnoud
2492ed1d9b
docs(angular-query): fix error in code snippet (#9645) 2025-09-12 01:31:48 +02:00
Pascal Weyrich
7f0e7161e4
docs(angular-query): use signal input in placeholder-query-data.md (#9641) 2025-09-12 00:16:24 +02:00
Arnoud
2283633684
docs(angular-query): update Angular Zoneless doc (#9616) 2025-09-04 14:05:23 +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
Lee
2989e69dc0
docs(react-query): recommend defaultError = unknown instead of AxiosError (#9575)
* docs(react-query): recommend defaultError = unknown instead of AxiosError

Signed-off-by: leesb971204 <leesb971204@gmail.com>

* docs(react-query): clarify usage of defaultError in global Error type registration

Signed-off-by: leesb971204 <leesb971204@gmail.com>

* ci: apply automated fixes

* docs(solid-query): recommend defaultError = unknown instead of AxiosError

Signed-off-by: leesb971204 <leesb971204@gmail.com>

* docs(angular-query): recommend defaultError = unknown instead of AxiosError

Signed-off-by: leesb971204 <leesb971204@gmail.com>

* docs(vue-query): add example code for Registering a global Error

Signed-off-by: leesb971204 <leesb971204@gmail.com>

---------

Signed-off-by: leesb971204 <leesb971204@gmail.com>
Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-08-18 17:46:32 +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]
7b0aaab005
ci: apply automated fixes (attempt 2/3) 2025-05-24 06:50:01 +00: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