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

555 commits

Author SHA1 Message Date
Wonsuk Choi
69839fe2fd
docs(vue/guides/paginated-queries): use 'import type' for 'Ref' (#12157) 2026-10-20 03:51:54 +09:00
Wonsuk Choi
054c244e75
docs(vue/reactivity): clarify that every query option accepts refs while only 'queryKey' and 'enabled' resolve getters (#12156) 2026-10-20 03:50:37 +09:00
Wonsuk Choi
5b6042cef9
docs(*): document the 'hideDisabledQueries' devtools option and its 'false' default (#12155) 2026-10-20 03:49:02 +09:00
Wonsuk Choi
a78393551c
docs(vue/plugins/createPersister): use 'localStorage' instead of the undefined 'AsyncStorage' in the examples (#12154) 2026-10-20 03:45:45 +09:00
Wonsuk Choi
341948658a
docs(vue/plugins/createPersister): document the 'removeQueries' function of the query persister (#12153) 2026-10-20 03:45:08 +09:00
Wonsuk Choi
9c80d0f4ce
docs(vue/reactivity): wrap the 'useQuery' options in an object, use 'toValue' for the 'MaybeRef' in 'enabled', and fix typos (#12152) 2026-10-20 03:43:17 +09:00
Wonsuk Choi
31041be074
docs(vue/guides/mutations): fix the error reset and paused mutations snippets that did not compile (#12151) 2026-10-20 03:39:13 +09:00
Wonsuk Choi
234eae8c3f
docs(vue/guides/dependent-queries): replace the removed 'isIdle' with 'status' and 'fetchStatus' and guard the undefined 'userIds' (#12150) 2026-10-20 03:37:09 +09:00
Wonsuk Choi
f83e0d5d9c
docs(vue/guides/testing): add a testing guide for composables with Vue Test Utils (#12149) 2026-10-20 03:32:55 +09:00
Wonsuk Choi
b2442d2bc4
docs(vue/guides/custom-client): pass the client to the devtools when using a custom 'queryClientKey' (#12148) 2026-10-20 03:32:11 +09:00
Wonsuk Choi
f275427cd0
docs(vue/installation): link to 'vuejs.org' instead of 'staging.vuejs.org' for '<script setup>' (#12147) 2026-10-20 03:21:35 +09:00
Wonsuk Choi
de6ac8e4ec
docs(vue/guides/custom-client): pass the client from 'useQueryClient' instead of the removed 'queryClientKey' query option (#12145) 2026-10-20 03:15:16 +09:00
Wonsuk Choi
db22bfc516
refactor(examples,docs): use 'TanStack/query' consistently in the GitHub API URLs (#12137)
* refactor(examples,docs): use 'TanStack/query' consistently in the GitHub API URLs

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-10-20 02:34:00 +09:00
autofix-ci[bot]
8c3f218b13
ci: apply automated fixes 2026-10-19 10:58:53 +00:00
Dominik Dorfmeister 🔮
1f8d134ea3
fix(react, preact): recompute mutation state snapshots (#12117)
* fix(react-query): recompute mutation state snapshots

* test(react-query): assert visible mutation counts

* fix(react-query): preserve mutation result references across renders

* fix(react-query): cache snapshots for non-plain selector results

* fix(preact-query): recompute mutation state snapshots

* Apply suggestion from @TkDodo

* fix: remove useMemo
2026-10-19 12:57:16 +02:00
Wonsuk Choi
4e413ae8bd
docs(svelte/ssr): update the SvelteKit snippets to Svelte 5 runes with 'PageProps' and 'LayoutProps', add the default 'staleTime' and the missing 'noop' import (#12115) 2026-10-19 10:04:54 +09:00
Wonsuk Choi
633d8e4bac
docs(solid): replace the deprecated 'route.load' with 'route.preload' in the SSR guide and the solid-start-streaming example (#12104) 2026-10-19 01:31:14 +09:00
Wonsuk Choi
68b655af86
docs({react,preact}/quick-start): use 'createRoot' in the React example and keep 'render' from 'preact' in the Preact example (#12080) 2026-10-18 22:27:47 +09:00
Wonsuk Choi
116687942b
docs(react/guides/ssr): add the default 'staleTime' to the 'Remove boilerplate' '_app' example (#12079) 2026-10-18 22:27:40 +09:00
Wonsuk Choi
ccbd483363
docs(react/guides/mutations): use 'createAsyncStoragePersister' instead of the deprecated 'createSyncStoragePersister' (#12078) 2026-10-18 22:27:33 +09:00
autofix-ci[bot]
1099ebb444
ci: apply automated fixes 2026-10-17 17:55:17 +00:00
Wonsuk Choi
ec80fda0c1
docs(framework/react/overview): throw on a non-ok 'fetch' response in the example, and in 'examples/react/simple' (#12057) 2026-10-17 18:03:41 +02:00
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]
acd8bbc984
ci: apply automated fixes 2026-10-15 07:39:46 +00:00
Wonsuk Choi
27346620ad
docs(*): exclude members declared in 'node_modules' from generated reference docs (#12014) 2026-10-15 10:09:02 +09:00
autofix-ci[bot]
6dc69dd265
ci: apply automated fixes 2026-10-12 12:14:45 +00:00
Dominik Dorfmeister 🔮
e22e7c4a27
chore: test TypeScript 7.1 preview and drop 5.6 (#11947)
* chore: test TypeScript 7.1 preview and drop 5.6

* chore: use a mature TypeScript 7.1 preview
2026-10-10 16:26:58 +02:00
autofix-ci[bot]
6a9a04f9bb
ci: apply automated fixes 2026-10-09 15:50:46 +00:00
Ciarán Curley
833062c2fc
chore: replace prettier with oxfmt (#11939)
Replace prettier with oxfmt

The options and ignores have been ported to the `.oxfmtrc.json` file (oxfmt `printWidth` default is 100 characters, so preserving 80 for now). While the configuration with Prettier is the same, oxfmt seems to modify some things slightly differently, apparently due to the use of a pre-3.9 Prettier layout for union types that break onto their own line so we still end up with about 30 files changed. 

Files with actual changes are:

- `.prettierignore`.`prettier.config.js`: Deleted. Replaced with `.oxfmtrc.json`
- `package.json`: `format` script changed to `oxfmt`. Added `oxfmt` and `svelte` as `devDependencies`; removed `prettier` and `prettier-plugin-svelte`.
- `pnpm-lock.yaml`: Lockfile update for the dependency changes above.
- `scripts/generate-labeler-config.ts`: Formats with oxfmt's `format()` API instead of Prettier's. It reads `.oxfmtrc.json` itself, because the API doesn't find config files on its own, and throws if formatting reports errors. Its output is identical to what Prettier produced.


Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-09 16:47:26 +01:00
Wonsuk Choi
71536972b5
docs(vue-query/useMutation): add JSDoc to 'MutationResult' (#11937)
* docs(vue-query/useMutation): add JSDoc to 'MutationResult'

* docs(vue-query): regenerate reference docs for 'MutationResult'
2026-10-10 00:05:13 +09:00
autofix-ci[bot]
817bd02659
ci: apply automated fixes 2026-10-09 11:19:04 +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
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
9dd4d7d506
docs(query-core/types): add JSDoc to the properties of the exported interfaces and type aliases (#11891)
* docs(query-core/types): add JSDoc to the properties of the exported interfaces and type aliases

* docs(query-core/types): mention mutations in the 'hydrate' default options description
2026-10-05 01:55:45 +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
1e6b56187f
docs(svelte-query): add JSDoc to the properties of the exported interfaces and type aliases (#11897) 2026-10-05 01:52:02 +09:00
Wonsuk Choi
25c1e6c1ad
docs(vue-query): add JSDoc to the properties of the exported interfaces and type aliases (#11896)
* docs(vue-query): add JSDoc to the properties of the exported interfaces and type aliases

* docs(vue-query/types): mention mutations in the 'hydrate' default options description
2026-10-05 01:51:28 +09:00
Wonsuk Choi
b18e7ab6f4
docs(solid-query): add JSDoc to the properties of the exported interfaces and type aliases (#11895) 2026-10-05 01:50:30 +09:00
Wonsuk Choi
0012ec14c3
docs(react-query): add JSDoc to the properties of the exported interfaces and type aliases (#11894) 2026-10-05 01:49:55 +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
2c39f03b44
docs(solid-query): add JSDoc to the exported classes, methods, and arrow functions (#11882)
* docs(solid-query): add JSDoc to the exported classes, methods, and arrow functions

* docs(solid-query-persist-client/PersistQueryClientProvider): describe what is deferred while restoring and when the callbacks run
2026-10-04 12:34:40 +09:00
Wonsuk Choi
c0f20a8259
docs(query-core): add JSDoc to the base methods of the exported classes (#11878) 2026-10-04 12:30:05 +09:00
Wonsuk Choi
01abab33f8
docs(*): note that 'throwOnError' makes the hook rethrow the errors of 'mutate' (#11877)
* docs(*): note that 'throwOnError' makes the hook rethrow the errors of 'mutate'

* docs(angular-query-experimental/types): mention that 'injectMutation' emits the error on 'ngZone.onError' before rethrowing it
2026-10-04 12:29:23 +09:00
Wonsuk Choi
5a8fa03f9a
docs(query-core/types): add JSDoc to the exported interfaces and type aliases (#11865) 2026-10-04 11:52:31 +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
baf66c5da9
docs(svelte-query): add JSDoc to the exported interfaces and type aliases (#11872) 2026-10-04 11:47:21 +09:00
Wonsuk Choi
27a8a89d8c
docs(vue-query): add JSDoc to the exported interfaces and type aliases (#11871)
* docs(vue-query): add JSDoc to the exported interfaces and type aliases

* docs(vue-query/useInfiniteQuery): exclude 'shallow' from the options that can be a 'ref'
2026-10-04 11:45:07 +09:00
Wonsuk Choi
0defd3b2e7
docs(solid-query): add JSDoc to the exported interfaces and type aliases (#11870) 2026-10-04 11:44:24 +09:00
Wonsuk Choi
e0cb6bd450
docs(preact-query): add JSDoc to the exported interfaces and type aliases (#11869) 2026-10-04 11:41:57 +09:00