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

68 commits

Author SHA1 Message Date
autofix-ci[bot]
73758917d1
ci: apply automated fixes 2026-11-01 12:51:26 +00:00
autofix-ci[bot]
fbfe33829a
ci: apply automated fixes 2026-11-01 12:12:10 +00:00
Wonsuk Choi
d88ba6ec46
docs(lit): remove '@tanstack/query-core' and 'lit' from the install commands to install only '@tanstack/lit-query' (#12209)
* docs(lit): remove '@tanstack/query-core' from the install commands since 'lit-query' already depends on it

* docs(lit): remove 'lit' from the install commands since apps using Lit Query already have it
2026-11-01 00:39:26 +09:00
autofix-ci[bot]
b74c5f61ef
ci: apply automated fixes 2026-10-26 10:19:26 +00:00
Wonsuk Choi
14cc3302e3
style(packages): write durations in 'count * unit * 1000' order (#12382)
* style(packages): write durations in 'count * unit * 1000' order

* docs(framework/*/reference): regenerate 'Query' reference for the 'isStaleByTime' example
2026-10-26 02:30:25 +09:00
Wonsuk Choi
bd816358c9
docs(framework): replace numeric separators with 'N * 1000' in snippet durations (#12380) 2026-10-26 02:19:46 +09:00
Wonsuk Choi
eea41e497f
docs(framework/lit/guides): update example snippets to the 'services/{domain}' query factories (#12375) 2026-10-26 02:06:55 +09:00
Wonsuk Choi
67eaf77279
docs(lit/guides/testing): add the testing guide with 'QueryClientProvider' and fake timers (#12206)
* docs(lit/guides/testing): add the testing guide with 'QueryClientProvider' and fake timers

* docs(lit/guides/testing): add the imports to the controller and fake timers examples so each can be used as its own file
2026-10-20 19:58:57 +09:00
Wonsuk Choi
56432b4a22
docs: use 'sh' instead of 'bash' for the shell code blocks (#12207) 2026-10-20 17:21:27 +09:00
Wonsuk Choi
88b3edde75
docs(lit/guides/mutations): rename the third 'onError' parameter from 'context' to 'onMutateResult' (#12194) 2026-10-20 14:10:46 +09:00
Wonsuk Choi
85f00d8731
docs(lit/guides/ssr): move inline 'type' specifiers to top-level 'import type' declarations (#12193) 2026-10-20 14:10:31 +09:00
Wonsuk Choi
fab1bc22d6
docs(lit/guides/query-keys): declare 'userId' in 'static properties' so changing it refetches (#12192) 2026-10-20 14:10:04 +09:00
Wonsuk Choi
1d016ddab7
docs(lit/{installation,typescript}): require 'useDefineForClassFields: false' so reactive properties initialized as class fields trigger updates (#12191) 2026-10-20 14:09:41 +09:00
Wonsuk Choi
93ecb10912
docs(lit/guides/query-functions): add 'as const' to the 'queryKey' so the destructured filters are typed (#12190) 2026-10-20 14:09:27 +09:00
autofix-ci[bot]
1099ebb444
ci: apply automated fixes 2026-10-17 17:55:17 +00: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
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
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
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
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
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
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
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
0362347c5c
docs(query-core/queryClient): correct the merge order described for 'defaultQueryOptions' and 'defaultMutationOptions' (#11861) 2026-10-04 05:20:23 +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
cbdb21468a
docs(*): replace JSDoc descriptions that only repeat the names and enforce 'jsdoc/informative-docs' (#11859)
* docs(*): replace JSDoc descriptions that only repeat the names

* chore(eslint.config): enforce 'jsdoc/informative-docs'
2026-10-04 05:08:09 +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
cada88ab41
docs(*): add missing JSDoc '@throws' tags and enforce 'jsdoc/require-throws' (#11856)
* docs(*): add missing JSDoc '@throws' tags

* chore(eslint.config): enforce 'jsdoc/require-throws'
2026-10-04 04:52:09 +09:00
Wonsuk Choi
29a29bbe12
docs(lit-query): add missing JSDoc to accessors, context errors, and result placeholders (#11844) 2026-10-04 04:16:31 +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
ffa2a29b35
docs(query-core/{infiniteQueryObserver,mutationObserver,queriesObserver}): add missing JSDoc to observer methods (#11837)
* docs(query-core/{infiniteQueryObserver,mutationObserver,queriesObserver}): add missing JSDoc to observer methods

* docs(query-core/infiniteQueryObserver): note that 'cancelRefetch: false' can reuse a running fetch in the page fetch return values

* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:56:34 +09:00
Wonsuk Choi
7a3ab9f36e
docs(query-core/timeoutManager): add missing JSDoc to 'TimeoutManager' methods and escape '@tanstack/query-core' (#11836)
* docs(query-core/timeoutManager): add missing JSDoc to 'TimeoutManager' methods and escape '@tanstack/query-core'

* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:55:40 +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
4ab74a72cf
docs(query-core/queryCache): add missing JSDoc to 'QueryCache' methods (#11834) 2026-10-04 02:53:45 +09:00
Wonsuk Choi
7883ad1102
docs(query-core/mutationCache): add missing JSDoc to 'MutationCache' methods (#11833) 2026-10-04 02:52:54 +09:00
Wonsuk Choi
68e670e1f5
docs(query-core/queryObserver): add missing JSDoc to 'QueryObserver' methods and fetch helpers (#11832) 2026-10-04 02:50:25 +09:00
Wonsuk Choi
7dd8803117
docs(query-core/query): add missing JSDoc to 'Query' members and state helpers (#11831)
* docs(query-core/query): add missing JSDoc to 'Query' members and state helpers

* docs(query-core/query): qualify the 'isStaleByTime' and 'fetch' parameter and return descriptions
2026-10-04 02:48:18 +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
ad9a67c0ee
docs(query-core/queryClient): add missing JSDoc '@param' and '@returns' to 'QueryClient' methods (#11829)
* docs(query-core/queryClient): add missing JSDoc '@param' and '@returns' to 'QueryClient' methods

* docs(query-core/queryClient): describe 'select' in the return values of 'query' and 'infiniteQuery'
2026-10-04 02:43:31 +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]
2bd18db590
ci: apply automated fixes 2026-09-27 13:54:37 +00:00
autofix-ci[bot]
bf3a04c21c
ci: apply automated fixes 2026-09-25 05:17:34 +00:00
Lachlan Collins
57f40eb05b
chore(deps): update non-major dependencies (#11625)
* chore(deps): update non-major dependencies

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-09-25 15:15:46 +10:00
Wonsuk Choi
10a5afcafb
docs(*): exclude protected members from generated reference docs (#11564) 2026-09-23 13:32:45 +09:00
Wonsuk Choi
baf7cc644b
docs(query-core): add JSDoc '@param' for 'QueryClient#setQueryData' options (#11571) 2026-09-22 11:27:13 +09:00
Wonsuk Choi
87c77175f9
docs(query-core): remove dead '@param' tags from 'streamedQuery' (#11570) 2026-09-22 11:25:53 +09:00