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

510 commits

Author SHA1 Message Date
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
Wonsuk Choi
b42166e557
docs(react-query): add JSDoc to the exported interfaces and type aliases (#11868) 2026-10-04 11:41:22 +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
4736791624
docs(*): end JSDoc descriptions with a period and start them with an uppercase letter and enforce 'jsdoc/match-description' (#11862)
* docs(*): end JSDoc descriptions with a period and start them with an uppercase letter

* chore(eslint.config): enforce 'jsdoc/match-description'
2026-10-04 05:23:56 +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
4024a9d03f
docs(angular-query-experimental): add missing JSDoc to 'createBaseQuery' and the mutation state helper (#11845)
* docs(angular-query-experimental): add missing JSDoc to 'createBaseQuery' and the mutation state helper

* docs(angular-query-experimental): note that 'createBaseQuery' keeps functions callable
2026-10-04 04:17:13 +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
ba341f5a07
docs(react-query): add missing JSDoc to react-query, react-query-next-experimental, and react-query-devtools (#11843)
* docs(react-query): add missing JSDoc to react-query, react-query-next-experimental, and react-query-devtools

* docs(react-query-next-experimental): correct where streamed hydration and HTML insertion happen
2026-10-04 04:15:50 +09:00
Wonsuk Choi
77ff943723
docs(preact-query): add missing JSDoc to preact-query and preact-query-devtools (#11842) 2026-10-04 04:15:08 +09:00
Wonsuk Choi
03786fbb93
docs(solid-query): add missing JSDoc to solid-query and solid-query-devtools (#11841) 2026-10-04 04:12:48 +09:00
Wonsuk Choi
16ae1d0cbd
docs(svelte-query): add missing JSDoc to svelte-query and svelte-query-persist-client (#11840) 2026-10-04 04:12:01 +09:00
Wonsuk Choi
7163033731
docs(vue-query): add missing JSDoc and move '@internal' after the descriptions (#11839) 2026-10-04 04:11:02 +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
Lachlan Collins
1c9693eac7
fix(codemods): update codemods build script (#11647)
* fix(codemods): update codemods build script

* Add changeset
2026-09-26 07:47:49 +10:00
autofix-ci[bot]
7a23df2abb
ci: apply automated fixes 2026-09-25 21:32:09 +00:00
Wonsuk Choi
9ff2ee3bbd
docs(vue-query): document how 'suspense()' resolves and handles errors, and fix the 'suspense' SSR examples (#11629)
* docs(vue-query): document how 'suspense()' resolves, including the disabled query caveat on the server

* docs(vue-query/suspense): add error handling with 'throwOnError' and 'onErrorCaptured'

* docs(vue-query/ssr): fix the Nuxt examples that call 'suspense' without destructuring it and destructure a nonexistent 'data2'

* docs(vue-query/suspense): note that 'suspense()' can resolve before the query function finishes

* docs(vue-query/{ssr,suspense}): scope the disabled 'suspense()' caveat to queries that stay disabled

* docs(vue-query/{ssr,suspense}): scope the SSR caveat heading to queries that stay disabled

* docs(vue-query/ssr): use 'vue' code blocks for the SFC examples
2026-09-25 23:34:07 +09:00
Wonsuk Choi
dfc3d9abed
docs(svelte-query/useMutationState): align the JSDoc description with the other adapters (#11624)
* docs(svelte-query/useMutationState): replace 'hook instance' with 'createMutation' call in JSDoc

* docs(svelte-query/useMutationState): align the JSDoc description with the other adapters
2026-09-25 14:27:22 +09: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
autofix-ci[bot]
077230bf29
ci: apply automated fixes 2026-09-24 10:02:48 +00:00
Wonsuk Choi
ac3256ad0d
docs(vue-query): redirect flat reference URLs broken by the TypeDoc migration (#11398)
docs(config): register redirect_from mappings for vue-query reference pages
2026-09-24 11:57:53 +09:00
Wonsuk Choi
852924d586
docs({react,preact}-query): fix a missing 'noop' import, a link, and typos in the SSR guide (#11591)
* docs({react,preact}-query): fix a missing 'noop' import, a link, and typos in the SSR guide

* docs(react-query): fix subject-verb agreement in the SSR guide's waterfall section
2026-09-23 18:11:51 +09:00
Wonsuk Choi
545911defe
docs(*): fix article and grammar typos in docs and comments (#11590) 2026-09-23 17:48:31 +09:00
changbaebang
1b24bc303f
docs(react-query): fix undefined userId in dependent query prefetch example (#11504)
The server-side example in the SSR guide checked `user?.userId` and then
referenced an undeclared `userId` variable. Align it with the client-side
example above it (and the Preact guide) by using `user?.id` / `user.id`.
2026-09-23 17:47:53 +09:00
Chris Z
36d8ebb324
docs(vue-query): fix 'loosing' typo in the v5 migration guide (#11580)
docs(vue): fix typo 'loosing' -> 'losing' in v5 migration guide

Correct the spelling of 'losing' in the v5 migration guide for the Vue
adapter. 'Loosing' means 'to release/unfasten', while 'losing' means
'to be deprived of' — the latter is the intended meaning here.

Co-authored-by: haimingZZ <haimingZZ@users.noreply.github.com>
Co-authored-by: Wonsuk Choi <sukvvon@gmail.com>
2026-09-23 17:22:39 +09:00
Wonsuk Choi
7176a1cfa9
docs(svelte-query/{createInfiniteQuery,infiniteQueryOptions}): describe overload selection by whether 'initialData' is known to be defined (#11589)
* docs(svelte-query/{createInfiniteQuery,infiniteQueryOptions}): describe overload selection by whether 'initialData' is known to be defined

* docs(svelte-query): regenerate reference docs
2026-09-23 17:07:05 +09:00
Wonsuk Choi
1b7250b3a0
docs(solid-query): replace the 'advanced-ssr' placeholder with a pointer to the SSR guide (#11588) 2026-09-23 14:58:19 +09:00
Wonsuk Choi
848b42129e
docs({react,preact,solid,vue}-query/useQuery): add 'initialDataUpdatedAt' to the seeding example (#11579) 2026-09-23 13:36:10 +09:00
Wonsuk Choi
10a5afcafb
docs(*): exclude protected members from generated reference docs (#11564) 2026-09-23 13:32:45 +09:00
Wonsuk Choi
04c0fa109f
docs(svelte-query): correct 'initialData'/'select' JSDoc inaccuracy (#11577) 2026-09-23 12:21:07 +09:00