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

143 commits

Author SHA1 Message Date
Wonsuk Choi
6c3cc51cf6
docs(angular/devtools): add an 'Embedded Mode' section for 'injectDevtoolsPanel' (#12320) 2026-10-25 10:48:27 +09:00
Wonsuk Choi
a5d5e00458
docs(*-devtools): describe how the 'theme' prop interacts with the theme selected in the devtools Settings menu (#12314) 2026-10-24 02:53:19 +09:00
Wonsuk Choi
9162d7f499
docs({angular,preact,solid,svelte,vue}/installation): state the supported framework versions to match the peer dependency ranges (#12210) 2026-10-20 20:52:25 +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
35c505a5f2
docs(angular/guides/testing): limit the 'whenStable' guidance to work that settles right away and point to fake timers for the rest (#12203) 2026-10-20 15:47:24 +09:00
Wonsuk Choi
b5fe9512df
docs(angular): use 'angular-ts' for the code blocks with '@Component' to highlight their templates (#12202) 2026-10-20 15:30:50 +09:00
Wonsuk Choi
a8f39eea4c
docs(angular/guides/testing): advance fake timers in the mutation example instead of awaiting 'whenStable' (#12201) 2026-10-20 15:26:14 +09:00
Wonsuk Choi
fb53a81e1c
docs(angular/guides/testing): advance fake timers instead of awaiting 'whenStable' in the component examples, and add Angular Testing Library and 'TestBed.runInInjectionContext' variants (#12199)
* docs(angular/guides/testing): advance fake timers and run 'detectChanges' in the component examples with 'TestBed' and Angular Testing Library instead of awaiting 'whenStable'

* docs(angular/guides/testing): add the 'TestBed.runInInjectionContext' variant to the component examples
2026-10-20 15:17:59 +09:00
Wonsuk Choi
608fca7426
docs(angular/guides/testing): advance fake timers in the infinite query example instead of awaiting 'whenStable' (#12197)
* docs(angular/guides/testing): advance fake timers in the infinite query example instead of awaiting 'whenStable'

* docs(angular/guides/testing): restore real timers in 'afterEach' in the infinite query example
2026-10-20 14:50:24 +09:00
Wonsuk Choi
4ea78d6bb2
docs(angular/overview): guard the error with 'isError()', rename the 'Response' interface to 'Repo', and remove the unused 'CommonModule' import (#12183) 2026-10-20 12:04:29 +09:00
Wonsuk Choi
86a9c88b38
docs(angular/guides/mutation-options): fix the duplicated 'query-options' id and inject the 'QueryClient' used in the example (#12182) 2026-10-20 12:04:14 +09:00
Wonsuk Choi
c223661efb
docs(angular/guides/testing): use 'provideHttpClientTesting' instead of the deprecated 'HttpClientTestingModule' and add 'initialPageParam' to the infinite query example (#12181) 2026-10-20 12:01:12 +09:00
Wonsuk Choi
4a18a7016e
docs(angular/guides/infinite-queries): add the required 'initialPageParam' to the bi-directional example (#12180) 2026-10-20 12:00:44 +09:00
Wonsuk Choi
ef39130852
docs(angular/guides/query-cancellation): pass filters to 'cancelQueries' and fix the imports of the 'HttpClient' example (#12179) 2026-10-20 12:00:25 +09:00
Wonsuk Choi
13d1f1c01f
docs(angular/quick-start): provide 'HttpClient' in the NgModule example (#12178) 2026-10-20 12:00:10 +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
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]
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
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
autofix-ci[bot]
6a9a04f9bb
ci: apply automated fixes 2026-10-09 15:50:46 +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
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
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
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
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
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
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