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

5,909 commits

Author SHA1 Message Date
Kirby
69e114aecf
fix(vue-query): export MutationResult type (#11796)
`UseMutationReturnType` uses `MutationResult` as the default for its
`TResult` parameter, but the alias was not exported. Projects that emit
declarations could not name the inferred return type of a `useMutation`
wrapper and failed with TS2883. Export it from the package root.

Fixes #11769

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Ciarán Curley <ciaran.curley.11.11@gmail.com>
2026-10-09 12:17:10 +01:00
Wonsuk Choi
aab352876a
chore(solid-query*): add 'eslint-plugin-solid' (#11929)
* chore(solid-query*): add 'eslint-plugin-solid'

* chore(solid-query*): explain why 'solid/reactivity' is off and keep it on in 'solid-query-persist-client'
2026-10-08 18:59:06 +09:00
Wonsuk Choi
01a7ebdd02
chore(preact-query*): clarify why the base rules from 'eslint-config-preact' are turned off (#11928) 2026-10-08 16:47:07 +09:00
Wonsuk Choi
79e2e4244e
chore(preact-query*): enable '@typescript-eslint/no-unnecessary-condition' outside tests (#11927) 2026-10-08 16:40:49 +09:00
Wonsuk Choi
24569675b6
chore(preact-query*): remove '@typescript-eslint/no-redeclare' (#11926) 2026-10-08 16:32:38 +09:00
Wonsuk Choi
c7a22584ea
chore(preact-query*): enable '@typescript-eslint/array-type' and '@typescript-eslint/no-unnecessary-type-assertion' (#11925) 2026-10-08 16:20:59 +09:00
Wonsuk Choi
93cb9cf6e4
chore(preact-query*): enable 'import/order' and 'sort-imports' (#11924) 2026-10-08 16:17:10 +09: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
271a4ed77e
refactor(lit-query): add the 'override' modifier to the implementations of the abstract controller hooks and document the hooks (#11913)
* refactor(lit-query): add the 'override' modifier to the implementations of the abstract controller hooks

* docs(lit-query/BaseController): note that 'onQueryClientChanged' also runs when no client is found

* docs(lit-query/BaseController): note that 'onConnected' may run without a client
2026-10-05 12:30:08 +09:00
Wonsuk Choi
eaa75f4f8f
chore(tsconfig): enable 'noImplicitOverride' (#11912) 2026-10-05 03:58:27 +09:00
Wonsuk Choi
4e1476cb69
test(solid-query): add the 'override' modifier to test classes that override a base class member (#11911) 2026-10-05 03:42:52 +09:00
Wonsuk Choi
7f0e7e2e36
test(preact-query): add the 'override' modifier to test classes that override a base class member (#11910) 2026-10-05 03:42:45 +09:00
Wonsuk Choi
ec66fc317b
test(lit-query): add the 'override' modifier to test classes that override a base class member (#11909) 2026-10-05 03:42:37 +09:00
Wonsuk Choi
d11907b937
test(query-core): add the 'override' modifier to test classes that override a base class member (#11908) 2026-10-05 03:42:29 +09:00
Wonsuk Choi
8a0a9b10c1
chore(eslint.config): require JSDoc on the methods of exported classes (#11907)
* chore(eslint.config): require JSDoc on the methods of exported classes

* chore(eslint.config): also require JSDoc on the methods of default-exported classes
2026-10-05 03:31:52 +09:00
Wonsuk Choi
ec8c6de884
refactor(lit-query): add the 'override' modifier to members that override a base class member (#11906) 2026-10-05 03:21:20 +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
65f762e292
refactor(query-core): add the 'override' modifier to members that override a base class member (#11904) 2026-10-05 03:20:52 +09:00
Wonsuk Choi
688f6e0722
docs(*): describe 'shadowDOMTarget' as the shadow DOM the devtools styles are applied within (#11902) 2026-10-05 02:17:04 +09:00
Wonsuk Choi
a6e8763a78
chore(eslint.config): require JSDoc on the properties of exported interfaces and type aliases (#11901) 2026-10-05 02:08:45 +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
e3415e0149
docs(eslint-plugin-query): add JSDoc to the properties of the exported interfaces and type aliases (#11900) 2026-10-05 01:55:10 +09:00
Wonsuk Choi
30e03ad077
docs(query-devtools): add JSDoc to the properties of the exported interfaces and type aliases (#11899) 2026-10-05 01:53:12 +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
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