Wonsuk Choi
852924d586
docs({react,preact}-query): fix a missing 'noop' import, a link, and typos in the SSR guide ( #11591 )
...
* docs({react,preact}-query): fix a missing 'noop' import, a link, and typos in the SSR guide
* docs(react-query): fix subject-verb agreement in the SSR guide's waterfall section
2026-09-23 18:11:51 +09:00
Wonsuk Choi
545911defe
docs(*): fix article and grammar typos in docs and comments ( #11590 )
2026-09-23 17:48:31 +09:00
changbaebang
1b24bc303f
docs(react-query): fix undefined userId in dependent query prefetch example ( #11504 )
...
The server-side example in the SSR guide checked `user?.userId` and then
referenced an undeclared `userId` variable. Align it with the client-side
example above it (and the Preact guide) by using `user?.id` / `user.id`.
2026-09-23 17:47:53 +09:00
Chris Z
36d8ebb324
docs(vue-query): fix 'loosing' typo in the v5 migration guide ( #11580 )
...
docs(vue): fix typo 'loosing' -> 'losing' in v5 migration guide
Correct the spelling of 'losing' in the v5 migration guide for the Vue
adapter. 'Loosing' means 'to release/unfasten', while 'losing' means
'to be deprived of' — the latter is the intended meaning here.
Co-authored-by: haimingZZ <haimingZZ@users.noreply.github.com>
Co-authored-by: Wonsuk Choi <sukvvon@gmail.com>
2026-09-23 17:22:39 +09:00
Wonsuk Choi
7176a1cfa9
docs(svelte-query/{createInfiniteQuery,infiniteQueryOptions}): describe overload selection by whether 'initialData' is known to be defined ( #11589 )
...
* docs(svelte-query/{createInfiniteQuery,infiniteQueryOptions}): describe overload selection by whether 'initialData' is known to be defined
* docs(svelte-query): regenerate reference docs
2026-09-23 17:07:05 +09:00
Wonsuk Choi
1b7250b3a0
docs(solid-query): replace the 'advanced-ssr' placeholder with a pointer to the SSR guide ( #11588 )
2026-09-23 14:58:19 +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
10a5afcafb
docs(*): exclude protected members from generated reference docs ( #11564 )
2026-09-23 13:32:45 +09:00
Wonsuk Choi
04c0fa109f
docs(svelte-query): correct 'initialData'/'select' JSDoc inaccuracy ( #11577 )
2026-09-23 12:21:07 +09:00
Wonsuk Choi
4cd7f1e35b
docs(solid-query): correct 'initialData'/'select' JSDoc inaccuracy ( #11576 )
2026-09-23 12:20:45 +09:00
Wonsuk Choi
96919caac5
docs(vue-query): correct 'initialData'/'select' JSDoc inaccuracy ( #11575 )
...
* docs(vue-query): correct 'initialData'/'select' JSDoc inaccuracy
* docs(vue-query): fix missed 'select' qualifier on 'DefinedInitialQueryOptions' JSDoc
2026-09-23 12:20:26 +09:00
Wonsuk Choi
d33b407d2a
docs({react,preact}-query): correct 'initialData'/'select' and 'QueriesOptions' fallback JSDoc inaccuracies ( #11574 )
...
* docs(react-query): correct inaccurate JSDoc statements
* docs(react-query): split QueriesOptions/SuspenseQueriesOptions JSDoc into paragraphs
* docs(preact-query): correct 'initialData'/'select' and 'QueriesOptions' fallback JSDoc inaccuracies
* docs({react,preact}-query): fix missed 'select' qualifier on 'DefinedInitialDataOptions' JSDoc
2026-09-23 12:19:55 +09:00
Wonsuk Choi
1fd9c6d7a5
docs(solid-query): add SSR guide for SolidStart ( #11581 )
...
* docs(solid-query): add SSR guide for SolidStart
* ci: apply automated fixes
* docs(solid-query): fix misleading 'staleTime' comment in SSR guide's 'app.tsx' example
* docs(solid-query): drop inaccurate 'gcTime' aside from the SSR guide's memory note
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-09-23 12:18:39 +09:00
Wonsuk Choi
129955c8fd
docs(vue-query): document 'queryKey'/'mutationKey' getter-entry unwrap gap ( #11573 )
2026-09-22 14:37:45 +09:00
Wonsuk Choi
baf7cc644b
docs(query-core): add JSDoc '@param' for 'QueryClient#setQueryData' options ( #11571 )
2026-09-22 11:27:13 +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
b5553313ba
docs(query-core): add JSDoc '@returns' for 'QueryClient' data accessors ( #11569 )
2026-09-22 11:17:08 +09:00
Wonsuk Choi
46b22a636f
docs(query-core): add JSDoc for 'Subscribable' and 'Removable' base classes ( #11565 )
2026-09-22 10:50:43 +09:00
Dami Oyeniyi
847f471e37
feat(svelte-query-devtools): add theme option ( #10636 )
...
Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
2026-09-21 20:09:29 +10:00
Wonsuk Choi
97cab92a7e
docs(solid-query): add JSDoc for re-declared 'queryKey' ( #11563 )
2026-09-21 12:01:41 +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
06869a8886
docs(solid-query): rewrite shared 'hook' prose to 'primitive' in guide frontmatter ( #11561 )
2026-09-21 10:45:13 +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
94de9b4e31
docs(svelte-query): call 'useIsMutating' a function instead of a hook ( #11559 )
2026-09-21 10:16:49 +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
47f27a4824
docs(svelte-query): add summaries to reference pages that render without a description ( #11553 )
2026-09-21 02:05:42 +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
2a495979b4
docs(query-core): add JSDoc for shared option and registry types ( #11552 )
2026-09-19 18:08:15 +09:00
Wonsuk Choi
54929cf71f
docs(query-core): add JSDoc for 'initialPageParam' ( #11551 )
2026-09-19 17:27:33 +09:00
Wonsuk Choi
8f6d322a5a
docs(query-core): add JSDoc for 'MutationOptions' ( #11550 )
2026-09-19 16:51:40 +09:00
Wonsuk Choi
d346e85f01
docs(*): promote default values from prose to '@defaultValue' tags ( #11538 )
2026-09-18 17:16:33 +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
autofix-ci[bot]
bb9d31306f
ci: apply automated fixes
2026-09-18 00:43:18 +00: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
Ahmet Tınastepe
12027efd5c
fix(vue-query): widen 'queryOptions' input to match 'useQuery' ( #11439 )
...
* fix(vue-query): widen 'queryOptions' input to match 'useQuery'
* chore: generate-docs
* chore: changeset
---------
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-09-15 09:00:40 +02:00
chungyoung kim
302345b90a
docs: explain Chrome focus emulation in window focus refetching guide ( #11457 )
2026-09-14 15:45:16 +02:00
Dami Oyeniyi
27cdf32c97
docs(persister): document asynchronous serialization callbacks ( #11411 )
...
Co-authored-by: grzdev <grzdev@users.noreply.github.com>
2026-09-14 15:32:30 +02:00
Dami Oyeniyi
ca0a74e7ae
docs(solid-query): correct devtools development-mode explanation ( #11409 )
...
Co-authored-by: grzdev <grzdev@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-09-14 15:32:19 +02:00
Kevin Van Cott
77647e96b5
docs(vue): fix reactivity guide heading hierarchy ( #11466 )
2026-09-14 15:25:17 +02:00
Tanner Linsley
8c191a966b
docs(react-query): link Start SSR integration guide ( #11472 )
2026-09-11 17:14:27 -06:00
Wonsuk Choi
87cd8cf855
docs(angular-query-experimental): use descriptive names for remaining generic class fields in guide examples ( #11446 )
2026-09-08 12:11:39 +09:00
Wonsuk Choi
390de5a8dd
docs(angular-query-experimental): add 'readonly' and use descriptive names for class fields in guide examples ( #11445 )
...
* docs(angular-query-experimental): add 'readonly' and use descriptive names for class fields in guide examples
* docs(angular-query-experimental): use descriptive names for class fields in 'placeholder-query-data.md'
2026-09-08 11:39:41 +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
1a51bb80bf
docs(*): clarify 'Promise.all' only waits for all mutateAsync calls when they succeed ( #11435 )
2026-09-07 00:31:27 +09:00
Peter Budai
aaf4ad94a5
docs(vue-query): skip hydration when Nuxt state is null ( #11429 )
...
fix(ssr): ensure hydration only occurs when vueQueryState is not null
2026-09-06 16:55:42 +02:00
Wonsuk Choi
345bb3d372
docs(angular-query-experimental): add 'readonly' to class fields in JSDoc examples ( #11416 )
2026-09-06 13:03:46 +09:00
Wonsuk Choi
9810709718
docs(angular-query-experimental): add JSDoc across the package ( #11406 )
...
* docs(angular-query-experimental): add JSDoc across the package and generate reference docs with TypeDoc
* docs(angular-query-experimental): address CodeRabbit review comments on JSDoc accuracy
* docs(angular-query-experimental): use 'changes' instead of 'narrows' for select's effect on TData
2026-09-06 12:12:24 +09:00