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

38 commits

Author SHA1 Message Date
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]
fbfe33829a
ci: apply automated fixes 2026-11-01 12:12:10 +00: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
autofix-ci[bot]
b74c5f61ef
ci: apply automated fixes 2026-10-26 10:19:26 +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
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
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
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
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
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
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
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
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
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
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
4cd7f1e35b
docs(solid-query): correct 'initialData'/'select' JSDoc inaccuracy (#11576) 2026-09-23 12:20:45 +09:00
Wonsuk Choi
87c77175f9
docs(query-core): remove dead '@param' tags from 'streamedQuery' (#11570) 2026-09-22 11:25:53 +09:00
Wonsuk Choi
64f1795ada
docs(query-core): add JSDoc for 'select' and 'defaultOptions' (#11562) 2026-09-21 11:25:46 +09:00
Wonsuk Choi
436a3baa93
docs(solid-query): call the adapter's APIs primitives instead of functions (#11560) 2026-09-21 10:34:21 +09:00
Wonsuk Choi
73a016baab
docs(solid-query): call the adapter's APIs functions instead of hooks (#11558) 2026-09-21 10:16:36 +09:00
Wonsuk Choi
3b45ebcadd
docs(solid-query): add summaries to reference pages that render without a description (#11554) 2026-09-21 01:47:02 +09:00
Wonsuk Choi
992c94234c
docs(query-core): inline option type aliases in generated reference docs (#11534)
* docs(query-core): inline option type aliases in generated reference docs

* docs(query-core): inline retry, notify and remaining option aliases
2026-09-18 17:08:56 +09:00
Wonsuk Choi
e0faf4d594
docs(*): render reference property lists as tables (#11533) 2026-09-18 16:53:17 +09:00
Wonsuk Choi
00059b8796
docs(*): regenerate reference docs to fix stale source links (#11521) 2026-09-17 10:05:02 +09:00
Wonsuk Choi
dcc2215986
docs(*): regenerate reference docs to fix stale source links (#11520) 2026-09-17 09:55:55 +09:00
Wonsuk Choi
e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* docs(query-core): add JSDoc across the package and expose it in generated reference docs

* docs(config.json): add sidebar entries for newly generated query-core reference docs

* docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc

* docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference

* docs(query-core): regenerate reference docs after merging main

* docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type

* fix(query-devtools): drop unnecessary 'query-core' project reference

* docs(query-core): document missing default values and normalize 'Defaults to' spacing

* docs(query-core): fix 'environmentManager' JSDoc example
2026-09-07 18:22:38 +02:00
Wonsuk Choi
49c7f46506
docs(solid-query/useMutation): add JSDoc examples for optimistic update rollback and parallel 'mutateAsync' calls (#11431)
* docs(solid-query/useMutation): add JSDoc examples for optimistic update rollback and parallel 'mutateAsync' calls

* docs(solid-query/useMutation): clarify 'Promise.all' only waits for all mutateAsync calls when they succeed
2026-09-07 00:52:49 +09:00
Wonsuk Choi
19c96a5134
docs(solid-query): remove 'The Query Options API' link, solid's queryOptions API differs from react's (#11387) 2026-09-04 11:42:55 +09:00
Wonsuk Choi
a29ca68867
docs: redirect flat reference URLs broken by the TypeDoc migration (#11379)
* chore(scripts/generate-docs): inject 'redirect_from' into flat reference URLs

* docs(react-query, solid-query): add 'redirect_from' for URLs broken by the TypeDoc migration
2026-09-03 18:08:28 +09:00
Wonsuk Choi
fe77cdc8d7
docs({react,preact,solid}-query): correct inaccurate JSDoc statements (#11372)
* docs(react-query): correct inaccurate JSDoc statements

* docs(preact-query): correct inaccurate JSDoc statements

* docs({react,preact,solid}-query): stop implying useQueries options are fully identical to useQuery
2026-09-03 10:42:36 +09:00
Wonsuk Choi
de8ab4db3e
docs(solid-query): add JSDoc and generate reference docs with TypeDoc (#11369)
* docs(solid-query): add JSDoc across the package

* docs(solid-query): generate reference docs with TypeDoc

* docs(config): register solid-query TypeDoc reference pages

* docs(solid-query): correct inaccurate JSDoc statements flagged in review
2026-09-03 10:19:23 +09:00