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

139 commits

Author SHA1 Message Date
autofix-ci[bot]
3148d57997
ci: apply automated fixes 2026-11-02 20:32:58 +00:00
autofix-ci[bot]
9e389a5fec
ci: apply automated fixes 2026-11-02 12:23:07 +00:00
autofix-ci[bot]
731d0eef12
ci: apply automated fixes 2026-11-01 15:47:04 +00:00
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
Yeongbin Jeong
89d0a1f564
docs(react-query): document re-render behavior during polling (#12433)
* docs(react-query): document re-render behavior during polling

* ci: apply automated fixes

---------

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-11-01 12:46:34 +01:00
Wonsuk Choi
979695d0a2
docs({react,preact,angular,solid,svelte,vue}-query): describe when the 'Defined' and 'Undefined' 'initialData' overloads are selected (#12460)
* docs({react,preact,angular,solid,svelte,vue}-query): describe the 'initialData' overloads as 'known to be defined' and 'omitted or may be undefined'

* docs({react,preact,angular,solid,svelte,vue}-query): regenerate reference docs

* docs({react,preact,angular,solid,svelte,vue}-query): mention an 'initialData' function that may return 'undefined' in the 'Undefined' overload descriptions

* docs({react,preact,angular,solid,svelte,vue}-query): regenerate reference docs
2026-10-30 16:41:25 +09:00
Wonsuk Choi
7ccba6e959
fix({react,preact,angular,solid,vue}-query/infiniteQueryOptions): correct the overload selected for a possibly-undefined 'initialData' (#11373)
* fix({react,preact,angular}-query): remove erroneous '| undefined' from 'DefinedInitialDataInfiniteOptions'

* test({react,preact,angular}-query/infiniteQueryOptions): use a non-literal condition for the ternary 'initialData' test

* fix({solid,vue}-query): accept a possibly-undefined 'initialData' in 'UndefinedInitialDataInfiniteOptions'

* fix(vue-query/infiniteQueryOptions): declare the 'Defined' overload first so a defined 'initialData' still selects it

* docs({react,preact,angular,solid,vue}-query): drop generated reference doc changes, regenerated by autofix after merge

* chore(.changeset): align the message with the PR title

* docs({react,preact,angular,solid,vue}-query/infiniteQueryOptions): describe overload selection by whether 'initialData' is known to be defined

* docs(framework/*/reference): regenerate reference docs

* docs(framework): restore the generated reference docs from main and leave them to autofix

* docs({react,preact,angular,solid,vue}-query): regenerate reference docs

* test({react,preact,angular,solid,vue}-query/infiniteQueryOptions): start test titles with 'should'
2026-10-30 10:06:32 +09:00
Wonsuk Choi
b9f369a23a
fix(solid-query/{queryOptions,useQuery}): correct the overload selected for 'initialData' (#11595)
* fix(solid-query/{queryOptions,useQuery}): correct the overload selected for 'initialData'

* ci: apply automated fixes

* docs(framework/*/reference): regenerate reference docs

* ci: apply automated fixes

* test(solid-query/queryOptions): assert the 'useQuery' data type when 'initialData' may be undefined

* docs(solid-query): regenerate reference docs

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-10-30 09:58:02 +09:00
Wonsuk Choi
2d5e6fcfc5
docs(solid): remove the leftover 'suspense' function and option mentions from the 'suspense' guide and quick start (#12427) 2026-10-28 11:05:13 +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
650c69abcd
docs(framework): write snippet durations in 'count * unit * 1000' order (#12381) 2026-10-26 02:26:34 +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
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
ca77c9f699
docs(solid/guides/testing): add the testing guide with 'renderHook' from '@solidjs/testing-library' (#12196)
* docs(solid/guides/testing): add the testing guide with 'renderHook' from '@solidjs/testing-library'

* docs(solid/guides/testing): restore real timers in 'afterEach' in the fake timers example
2026-10-20 14:50:47 +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
Wonsuk Choi
633d8e4bac
docs(solid): replace the deprecated 'route.load' with 'route.preload' in the SSR guide and the solid-start-streaming example (#12104) 2026-10-19 01:31:14 +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
Dominik Dorfmeister 🔮
e22e7c4a27
chore: test TypeScript 7.1 preview and drop 5.6 (#11947)
* chore: test TypeScript 7.1 preview and drop 5.6

* chore: use a mature TypeScript 7.1 preview
2026-10-10 16:26:58 +02: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
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
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
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
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
0defd3b2e7
docs(solid-query): add JSDoc to the exported interfaces and type aliases (#11870) 2026-10-04 11:44:24 +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
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
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