0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
Commit graph

47 commits

Author SHA1 Message Date
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
1a51bb80bf
docs(*): clarify 'Promise.all' only waits for all mutateAsync calls when they succeed (#11435) 2026-09-07 00:31:27 +09:00
Wonsuk Choi
fc51e96045
docs(react-query, preact-query): use 'button' instead of undefined 'Button' in suspense guide examples (#11390) 2026-09-04 16:00:13 +09:00
Wonsuk Choi
9ea8ea0030
docs(preact-query): fix broken TkDodo link mangled by 'react-query'->'preact-query' replace (#11389) 2026-09-04 16:00:02 +09:00
Jooyoung Shin
ec3f992cbf
docs(preact-query): add 'Suspense' and 'Testing' guides (#11377)
docs(preact-query): add Suspense and Testing guides

The Preact docs had no counterpart for the React "Suspense" and
"Testing" guides even though `@tanstack/preact-query` ships the
suspense hooks and `QueryErrorResetBoundary`.

Follow the existing Preact docs convention: reference the React guide
via `ref:` + `replace:` and override only the React-specific sections
(`preact/compat` Suspense, an error boundary built on `useErrorBoundary`,
`@testing-library/preact`). The React guides only gain the section
markers needed for the overrides; their wording is unchanged.
2026-09-04 15:11:20 +09:00
Wonsuk Choi
b81a6396c6
docs(preact-query): add 'The Query Options API' link, matching react's queryOptions JSDoc (#11388) 2026-09-04 12:04:31 +09:00
Wonsuk Choi
d29e7cf0b5
docs(preact-query): fix XSS-unsafe example and missing 'staleTime' in SSR guide (#11381) 2026-09-03 23:00:16 +09:00
Wonsuk Choi
2c5ba585ac
docs(preact-query): add 'Server Rendering & Hydration' guide (#11380)
* docs(preact-query): add 'Server Rendering & Hydration' guide

* docs(preact-query): add 'serializeData'/'deserializeData' to SSR guide
2026-09-03 21:48:01 +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
1a5331a2ab
docs(preact-query): correct inaccurate JSDoc statements (#11367)
* docs(preact-query): correct inaccurate JSDoc statements

* docs(preact-query): regenerate reference docs
2026-09-02 16:25:19 +09:00
Wonsuk Choi
a85d4f16c9
docs(preact-query): correct 'pending' status description in useQuery's @returns (#11354) 2026-09-01 16:55:30 +09:00
Wonsuk Choi
acf8a3631f
docs(preact-query): rename onError's third example parameter from 'context' to 'onMutateResult' (#11353) 2026-09-01 15:50:46 +09:00
Wonsuk Choi
2b44804d18
docs(preact-query): add 'select' example to 'useQuery' (#11343)
* docs(preact-query): add 'select' example to 'useQuery'

* docs(preact-query): move 'select' example right after the basic 'useQuery' example

* docs(preact-query): make 'select' example derive a different type instead of a subset
2026-08-31 12:29:20 +09:00
Wonsuk Choi
6a732234c7
docs(preact-query): remove hover-prefetch example from 'useQuery'/'useInfiniteQuery' (#11341) 2026-08-31 09:39:25 +09:00
Wonsuk Choi
87fa4c1628
docs(preact-query): define 'App' before 'ErrorBoundary' in 'QueryErrorResetBoundary' example (#11338) 2026-08-31 02:52:42 +09:00
Wonsuk Choi
9633f7998f
docs(preact-query): add 'QueryErrorResetBoundary' and 'ErrorBoundary' to 'useSuspenseQuery'/'useSuspenseInfiniteQuery'/'useSuspenseQueries' examples (#11337)
* docs(preact-query): add 'ErrorBoundary' to 'useSuspenseQuery'/'useSuspenseInfiniteQuery'/'useSuspenseQueries' examples

* docs(preact-query): correct suspense error contract wording ('data'/query error, no-cached-data condition)
2026-08-31 02:42:06 +09:00
Wonsuk Choi
ffcf9a365e
docs(preact-query): trim 'queryOptions'/'infiniteQueryOptions' examples to what the factory needs to prove (#11336)
docs(preact-query): trim 'queryOptions'/'infiniteQueryOptions' examples to what the factory itself needs to prove
2026-08-31 01:08:50 +09:00
Wonsuk Choi
08dc65a9b5
docs(preact-query): inline 'useQuery''s basic-example options instead of a 'queryOptions' factory (#11331) 2026-08-30 15:26:58 +09:00
Wonsuk Choi
d5402b9284
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301)
* docs(preact-query): wrap 'useIsFetching' example in a component

* docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling

* docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components

* docs(preact-query): wrap 'queryOptions' examples in components

* docs(preact-query): wrap 'infiniteQueryOptions' example in a component

* fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example

* fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples

* docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example

* docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example

* docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples

* docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example

* docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example

* docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples

* docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags

* docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples

* docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery'

* docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks

* docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal

* docs(preact-query): add 'skipToken' examples for type-safe conditional disabling

* docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples

* docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples

* docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it

* docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions'

* docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example'

* docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks

* docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks'

* docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks

* docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark

* docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit

* docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
Wonsuk Choi
44645e9eb1
docs(preact-query): rename 'results' to 'postQueries' in 'useSuspenseQueries' example (#11299) 2026-08-26 15:16:52 +09:00
Wonsuk Choi
dbd8fbab49
docs(preact-query): document request-waterfall avoidance across 'useSuspenseQuery' and 'useSuspenseQueries' (#11298)
* docs(preact-query): warn about request waterfalls and point to 'useSuspenseQueries' in 'useSuspenseQuery'

* docs(preact-query): add multiple-parallel-queries example to 'useSuspenseQueries'
2026-08-26 14:52:10 +09:00
Wonsuk Choi
e17de345ce
docs(preact-query): remove redundant 'infiniteQueryOptions' usage from 'useInfiniteQuery' examples (#11297) 2026-08-26 13:59:02 +09:00
Wonsuk Choi
904ab016b0
docs(preact-query): use function declarations instead of arrow functions in example code (#11296) 2026-08-26 13:44:13 +09:00
Wonsuk Choi
f6ed6e4bde
docs(preact-query): expand JSDoc @example coverage across hooks (#11295)
* fix(preact-query): guard 'fetchNextPage' example with 'isFetching', not just 'isFetchingNextPage'

* docs(preact-query): add global loading indicator example to 'useIsFetching'

* docs(preact-query): add mutation-state, 'Promise.all', and 'Promise.allSettled' examples to 'useMutation'

* docs(preact-query): add 'isPending'/'isError' example alongside 'status' to 'useQuery'

* docs(preact-query): fix dependent-query example in 'useQuery' to use 'isLoading' instead of 'isPending'

* docs(preact-query): add pagination example with 'keepPreviousData' to 'useQuery'

* docs(preact-query): correct consecutive-mutation callback wording in 'useMutation' example

* docs(preact-query): add per-call 'onError' callback to basic 'useMutation' example

* docs(preact-query): use contextual message in 'console.error' for 'Promise.all' example in 'useMutation'
2026-08-26 13:31:02 +09:00
Wonsuk Choi
d09cf1d605
docs(preact-query): backtick bare code-symbol references in JSDoc ('QueryClient', 'suspense', 'throwOnError') (#11290)
* docs(preact-query): wrap bare 'QueryClient' type name in backticks in JSDoc

* docs(preact-query): backtick 'QueryClient' in 'children' prop doc and 'suspense'/'throwOnError' in QueryErrorResetBoundary
2026-08-26 00:14:24 +09:00
Wonsuk Choi
e6503b0990
docs(preact-query): cross-link hooks with their options factories via '@see' and move the infinite-query caveat to '@remarks' (#11289) 2026-08-25 23:28:25 +09:00
Wonsuk Choi
0a16a362dd
docs(preact-query): tag 'subscribed' with '@defaultValue' for structured default-value rendering (#11288) 2026-08-25 23:15:31 +09:00
Wonsuk Choi
84b4f13470
docs(preact-query): document type parameters with '@template' and add 'useQueryClient' throws note (#11285)
* docs(preact-query): document type parameters with '@template' and add 'useQueryClient' throws note

* docs(preact-query): fix TQueryData select direction and TResults/TDepth phrasing flagged by CodeRabbit
2026-08-25 21:28:15 +09:00
Wonsuk Choi
5bb950be80
docs(preact-query): document interfaces and type aliases with JSDoc for generated reference docs (#11284)
* docs(preact-query): document interfaces and type aliases with JSDoc for generated reference docs

* docs(preact-query): fix finite/infinite mix-ups and opaque-array fallback claims flagged by CodeRabbit
2026-08-25 19:35:48 +09:00
Wonsuk Choi
720725d113
docs(preact-query): import 'noop' from '@tanstack/preact-query' instead of '@tanstack/query-core' in examples (#11283) 2026-08-25 17:06:26 +09:00
Wonsuk Choi
870bd854cc
docs(preact-query): document functions and components with JSDoc for generated reference docs (#11204)
* docs(preact-query): document functions and components with JSDoc for generated reference docs

* docs(preact-query): replace concrete API calls with abstract fetcher names in JSDoc examples

* docs(preact-query): rename mutation example fetcher to be CRUD-neutral

* docs(preact-query): rename mutation example fetcher to 'createPosts'

* docs(preact-query): add examples for Suspense, prefetch, and options-builder functions

* docs(preact-query): add optimistic update, dependent query, and SSR hydration examples

* docs(preact-query): add parameterized factory and mutationKey lookup examples to queryOptions/mutationOptions

* docs(preact-query): add infiniteQueryOptions factory example and restore useMutationState's third example

* docs(preact-query): add TkDodo-inspired multi-API reuse, initialData, and per-call mutate callback examples

* docs(preact-query): document useIsRestoring, initialData, mutateAsync, and skipToken-excluded queryFn fields

* docs(preact-query): fill in empty Returns sections for hooks and options builders

* docs(preact-query): systematic sweep of generated pages for missing field descriptions and fix mismatched mutationOptions example

* docs(preact-query): split mutationOptions' mutationKey overload into basic usage and lookup examples

* docs(preact-query): fix overloads whose example didn't match their initialData-required type

* docs(preact-query): fill overloads missing examples and useSuspenseQueries' queryClient param description

* docs(preact-query): remove duplicated overload example and fix examples that failed type-checking

* docs(preact-query): describe every documented parameter and restore reverted overload example

* docs(preact-query): describe children props and low-level context exports

* fix(preact-query): remove inaccurate 'queryFn is optional' claim from infiniteQueryOptions overload

* docs(preact-query): add missing @returns to mutationOptions overloads and provider components

* docs(preact-query): describe QueryErrorResetBoundary children and its render-function parameter

* docs(preact-query): fix prose-accuracy issues found by multi-agent audit

Corrects useQuery's first overload @returns to match its actual return
type, moves the useSuspenseQuery/useSuspenseInfiniteQuery cancellation
caveat out of the @returns block, softens overstated skipToken/queryFn
claims, merges a duplicated useMutationState description, and adds
missing JSDoc to QueryErrorResetBoundary's function-type aliases and
UseMutateFunction/UseMutateAsyncFunction.

* docs(preact-query): soften remaining overstated queryFn requirement in Suspense options

* docs(preact-query): fix inaccurate prose in hydration, queryFn, and useQueries docs

* docs(preact-query): correct hydration freshness gate, placeholderData arity, and deprecated 'fetchInfiniteQuery' reference

* docs(preact-query): remove leftover 'data is never undefined' claim in 'useInfiniteQuery' overload docs

* docs(preact-query): replace deprecated 'prefetchQuery'/'prefetchInfiniteQuery' calls in examples with 'query'/'infiniteQuery'

* docs(preact-query): point 'usePrefetchQuery' JSDoc at 'queryClient.query' to match its actual option type
2026-08-25 16:43:01 +09:00
Wonsuk Choi
0c36448862
docs: regenerate TypeDoc reference for angular, svelte, preact, lit (#11267) 2026-08-24 10:20:01 +09:00
Ciarán Curley
4e48c581b7
Preact: update usePrefetchQuery to use new methods with docs (#10669)
* feat(preact-query): use new methods for usePrefetchQuery plus tests

* docs(preact-query): updated docs for usePrefetchQuery

* Update docs/framework/preact/reference/interfaces/UsePrefetchInfiniteQueryOptions.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update packages/preact-query/src/usePrefetchInfiniteQuery.tsx

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>

* Update packages/preact-query/src/usePrefetchQuery.tsx

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-08-20 18:35:10 +02:00
Wonsuk Choi
f1a435977f
docs: regenerate reference docs to drop redundant TypeDoc page title heading (#11196) 2026-08-16 22:08:19 +09:00
Wonsuk Choi
a9f416bbae
docs: regenerate reference docs to fix stale content and Preact source links (#11189) 2026-08-16 17:58:55 +09:00
Dmytro Borysov
ad57c81fd3
docs(devtools): make markdown consistent (#10987)
Currently there is a bug, which prevents proper rendering of the links if there are both MD & HTML syntax in the same line (see https://tanstack.com/query/latest/docs/framework/react/devtools), probably should be fixed in @tanstack/markdown. Not sure that the source code of this package is published?

In the meantime, I just converted all links to html.

Converting everything (logos) to markdown won't work because we need to set width/height, which can't be done in markdown
2026-06-27 21:50:32 +02:00
Poetry Of Code
661c1afe79
docs(preact): add polling guide (#10991)
* docs(svelte): replace deprecated isLoading with isPending in overview

`isLoading` is a deprecated alias for `isPending && isFetching` and is
scheduled for removal in the next major version. The overview example
shows a standard (always-enabled) query, so `isPending` is the correct
flag. All other framework overview docs (React, Vue, Angular, Lit,
Preact) already use `isPending`.

Note: `isLoading` is intentionally retained in disabling-queries guides
where it is the right flag for disabled/lazy queries.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(preact): add missing polling guide

The Polling guide existed for React, Vue, Solid, and Angular but was
missing from the Preact docs. Added the ref stub and wired it into
the nav config between Window Focus Refetching and Disabling Queries,
matching the ordering used by all other frameworks.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-27 15:45:37 +02:00
Wonsuk Choi
1b4e73161f
docs(framework/{preact,solid}/devtools): add the 'Embedded Mode' section (#10853) 2026-06-01 15:10:21 +09:00
Dami Oyeniyi
0d63459555
docs(devtools): correct 'errorTypes' type to array (#10634)
docs(devtools): document errorTypes as array
2026-05-05 12:08:07 +09:00
Wonsuk Choi
bf2546feb0
docs(devtools): add missing 'theme' option (#10621) 2026-05-02 10:50:20 +09:00
Wonsuk Choi
868577d5da
docs(devtools): align logo, panel, and option union descriptions across docs and JSDoc (#10617)
* docs(devtools): replace framework-specific logo with 'TanStack logo' to match the actual rendered component

* docs(vue-query/devtools): replace 'React Query' panel leftover with 'Vue Query'

* docs(devtools): replace framework-specific logo with 'TanStack logo' and use adapter naming for 'devtools panel' in JSDoc

* docs(devtools): add missing 'relative' to JSDoc 'buttonPosition' union

* chore(.changeset): add changeset for devtools logo, panel, and 'buttonPosition' union alignment

* docs(preact-query-devtools): add missing 'position' union to JSDoc
2026-05-01 16:34:40 +09:00
Wonsuk Choi
0694696025
docs(preact-query/devtools): add missing 'relative' to 'buttonPosition' (#10611) 2026-04-29 23:41:15 +09:00
Jovi De Croock
887541a2fa
Add preact persist plugin (#10120)
* Add preact persist plugin

* Add docs

* Add tests

* Fix type issue

* ci: apply automated fixes

* Fixes

* Update changeset for preact-query packages

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2026-03-02 08:43:33 +01:00
Jovi De Croock
8fb3a5a6f1
Add preact query devtools (#10119)
* Add preact query devtools

* chore(deps): update dependency @sveltejs/kit to v2.52.2 [security] (#10158)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* ci: apply automated fixes

* knip

* Another fix

* Update versioning for preact-query packages

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2026-03-01 19:07:24 +01:00
vedanta
4511b636ea
chore(preact-query): Preact docs match fix (#10171)
* chore(preact-query): dual-match-pattern in docs

* window-focus-native fix
2026-02-22 12:57:08 -06:00
vedanta
ce94b37d6a
preact-docs problems fixed (#10160)
Things like Preact-Native, Preact 18.0+ is a remnant of using react-docs but without section-wise splitting. This handles that.
2026-02-21 19:37:16 -06:00
vedanta
8f0d834382
feat: Preact Adapter (#9935)
* initial setup -- duplicated + package.json edited

* simple preact updations

* missed a React.ReactNode

* testing grunt work (preact library + other small issues + ErrorBoundary custom implementation)

* missed a few

* Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality

* useSuspenseQueries left -- removed the useQuery.promise tests

* forgot the console logs

* useSuspenseQueries 2 resolved; tests done

* ci: apply automated fixes

* fix: example

* fix: configs should be symlinks

* fix: sync versions for npm-run-all2

* ref: re-sync runall2

* ref: go back to 5.0.0

* ref: remove changelog

* react-query -> preact-query

* remove use client directive + added the useSyncExternalStore (decoupled from compat)

* remove the react remnants

* generate docs

* typescript eslint

* docs

* vite config fix

* docs now reference react docs (most of them atleast)

* code-rabbit issues addressed

* <div/> lol

* fix: docs

* ci: apply automated fixes

* fix: lockfile

* fix: duplicated versions

* lockfile (I cooked or am I cooked)

* ci: apply automated fixes

* Making small edits to fix versioning, warnings, and lock

* unhandled error compat

* Fixing CI

* Fixed the CI errors

* ci: apply automated fixes

* Prettier format

* Update changeset for Preact Adapter feature

---------

Co-authored-by: TkDodo <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 12:02:20 +01:00