0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
Commit graph

5,683 commits

Author SHA1 Message Date
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
0aa83a0188
docs(*): add JSDoc to the properties of the exported interfaces and type aliases of the persisters and the broadcast client (#11893) 2026-10-05 01:49:21 +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
cacd9cb8ca
chore(eslint.config): require JSDoc on exported classes and arrow functions (#11890)
* chore(eslint.config): require JSDoc on exported classes and arrow functions

* chore(eslint.config): also require JSDoc on default-exported classes and arrow functions
2026-10-05 01:37:10 +09:00
Wonsuk Choi
f9fe54c960
docs(eslint-plugin-query): add JSDoc to the exported classes, methods, and arrow functions (#11888) 2026-10-04 13:06:11 +09:00
Wonsuk Choi
7933146d9a
docs(query-test-utils): add JSDoc to the exported classes, methods, and arrow functions (#11887) 2026-10-04 13:05:36 +09:00
Wonsuk Choi
0e8090514c
docs(query-devtools): add JSDoc to the exported classes, methods, and arrow functions (#11886) 2026-10-04 13:05:03 +09:00
Wonsuk Choi
fa539fee3b
docs(lit-query): add JSDoc to the exported classes, methods, and arrow functions (#11885) 2026-10-04 13:04:30 +09:00
Wonsuk Choi
51b43f8599
docs(angular-query-experimental): add JSDoc to the exported classes, methods, and arrow functions (#11884) 2026-10-04 12:36:48 +09:00
Wonsuk Choi
71c663576d
docs(svelte-query): add JSDoc to the exported classes, methods, and arrow functions (#11883)
* docs(svelte-query): add JSDoc to the exported classes, methods, and arrow functions

* docs(svelte-query/utils): describe that 'watchChanges' runs on every change of the state its sources read
2026-10-04 12:36:12 +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
fce806b53f
docs(preact-query): add JSDoc to the exported classes, methods, and arrow functions (#11881)
* docs(preact-query): add JSDoc to the exported classes, methods, and arrow functions

* docs(preact-query-persist-client/PersistQueryClientProvider): describe what is deferred while restoring and when the callbacks run
2026-10-04 12:33:32 +09:00
Wonsuk Choi
b5e8e7b697
docs(react-query): add JSDoc to the exported classes, methods, and arrow functions (#11880)
* docs(react-query): add JSDoc to the exported classes, methods, and arrow functions

* docs(react-query-persist-client/PersistQueryClientProvider): describe what is deferred while restoring and when the callbacks run
2026-10-04 12:32:24 +09:00
Wonsuk Choi
72c68cc353
docs(*): add JSDoc to the exported classes, methods, and arrow functions of the persisters (#11879) 2026-10-04 12:30:39 +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
c1c27a7ba5
chore(eslint.config): require JSDoc on exported interfaces and type aliases (#11876) 2026-10-04 12:28: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
847036b577
docs(eslint-plugin-query): add JSDoc to the exported interfaces and type aliases (#11875)
* docs(eslint-plugin-query): add JSDoc to the exported interfaces and type aliases

* docs(eslint-plugin-query): name the exact config keys in the 'Plugin' description
2026-10-04 11:49:45 +09:00
Wonsuk Choi
51fb92520f
docs(query-devtools): add JSDoc to the exported interfaces and type aliases (#11874)
* docs(query-devtools): add JSDoc to the exported interfaces and type aliases

* docs(query-devtools/contexts/types): note that 'onClose' is only used by the panel
2026-10-04 11:48:29 +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
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
0131c84b7e
docs(*): add JSDoc to the exported interfaces and type aliases of the persisters (#11867) 2026-10-04 11:40:49 +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
a83ce667da
chore(preact-query-devtools): replace the stale 'root.tsdown.config.js' copy with a symlink to the shared config (#11864) 2026-10-04 05:41:45 +09:00
Wonsuk Choi
4acb1765f7
chore(eslint.config): add 'refetched' to the 'cspell' words (#11863) 2026-10-04 05:27:02 +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
6c755231dc
chore(eslint.config): enable the 'jsdoc' rules outside the recommended config that have no violations (#11855) 2026-10-04 04:46:23 +09:00
Wonsuk Choi
327b6b9ab7
chore(eslint.config): extend the error variant of the 'eslint-plugin-jsdoc' recommended config (#11854) 2026-10-04 04:36:16 +09:00
Wonsuk Choi
53899d916f
chore(angular-query-persist-client/eslint.config): remove the package-specific 'jsdoc' rules in favor of the root config (#11853) 2026-10-04 04:36:08 +09:00
Wonsuk Choi
387466debd
chore(eslint.config): use 'extends' for the 'eslint-plugin-jsdoc' recommended config (#11852) 2026-10-04 04:30:16 +09:00
Wonsuk Choi
c074a13ddb
chore(eslint.config): enforce the 'jsdoc' rules that have no remaining violations (#11851) 2026-10-04 04:27:21 +09:00
Wonsuk Choi
fe30a84837
docs(eslint-plugin-query): add missing JSDoc to rule helpers and utilities (#11848) 2026-10-04 04:19:20 +09:00
Wonsuk Choi
6dbbc36963
docs(query-devtools): add missing JSDoc to components, contexts, and utilities (#11847) 2026-10-04 04:18:36 +09:00
Wonsuk Choi
91f5d9b6c3
docs(*): add missing JSDoc to the persisters and the broadcast client (#11846)
* docs(*): add missing JSDoc to the persisters and the broadcast client

* docs(*): describe the broadcast event filters and the restore cleanup errors
2026-10-04 04:17:55 +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