* 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
* docs(vue-query): add JSDoc across the package
* docs(vue-query): generate reference docs with TypeDoc
* docs(config): register vue-query TypeDoc reference pages
* docs(vue-query): preserve dehydrate/hydrate option docs and fix reference links
* docs(config): reorder vue-query reference nav to list 'Functions' first
* docs(config): reorder vue-query 'Functions' entries to match react/preact grouping
* docs(vue-query): restore Suspense guide link and 'placeholderData' behavior note lost in TypeDoc migration
* docs(vue-query): correct JSDoc accuracy issues and reactivity bugs
* docs(vue-query): fix invalidateQueries example that invalidated every query, add whole-options getter example
* docs(vue-query): add examples for the mutationOptions and useInfiniteQuery getter overloads
* docs(vue-query): add react-parity examples for select, skipToken, keepPreviousData, optimistic updates, and infinite scroll
* docs(vue-query): add queryOptions select typing example to useQueries
* docs(vue-query): disconnect IntersectionObserver on unmount, drop non-null assertion in skipToken examples
* docs(vue-query): add 'skipToken' factory example to 'queryOptions'
* docs(vue-query): correct 'queryKey' reactive-getter claim in 'useQuery'/'useInfiniteQuery'
* docs(vue-query): correct 'queryKey' reactive-getter claim in 'QueryOptions' type JSDoc
* docs(vue-query): fix reversed claim that 'queryKey' entries can't be reactive getters
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.
* 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
* docs(vue-query,solid-query): inline react reference content instead of 'ref'-ing hand-written react docs
* docs(react-query): generate reference docs with TypeDoc
* docs(vue-query,solid-query): fix dangling suspense-hook links left over from the react content copy
* docs(solid-query): apply solid's callback call form to inlined reference examples
* docs(react-query): correct inaccurate JSDoc statements flagged in review
* docs(vue-query,solid-query): fix reactivity-aware examples and inaccurate type signatures flagged in review
* docs(vue-query,solid-query): fix remaining type/behavior inaccuracies flagged in second review
* docs(react-query): stop implying a default queryFn defers a fetch the way 'enabled: false' does
* docs(vue-query): mark 'mutate'/'mutateAsync' per-call options as optional
* 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
* 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
* docs(preact-query): warn about request waterfalls and point to 'useSuspenseQueries' in 'useSuspenseQuery'
* docs(preact-query): add multiple-parallel-queries example to 'useSuspenseQueries'
* 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'
* 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
* 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
* 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
* 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
The type narrowing example wraps useQuery() in reactive() without saying
why, so destructuring the result directly and then checking isSuccess
looks like it should work (#9244). Spell out that reactive() is what
flattens the refs into one discriminated union, and show the
data.value !== undefined check as the alternative when reactive() is not
an option.
Pin both shapes with type tests: the non-reactive result exposes
Ref<T> | Ref<undefined>, and narrowing on data.value refines the ref
itself.
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
* feat(vue-query): add new methods to vue-query
* docs(vue-query): docs for new impertive methods for Vue
* fix(vue-query): remove getter options from impertive methods
There is no evidence that the () => queryOptions getter type is
properly used by `fetchQuery` et al, as while it accepts a getter in the
types, it doens't resolve the function at runtime (as opposed to
`useQuery`). Removing the type from `query` and `fetchQuery` and
documenting calling getters impertivly as a workaround.
* Update packages/vue-query/src/queryClient.ts
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
* Update packages/vue-query/src/usePrefetchQuery.ts
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
---------
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
* fix(broadcast-client): handle unhandled postMessage rejections
Wrap channel.postMessage() calls in safePost() to catch DataCloneError
and similar failures that occur when query data contains non-cloneable
values (ReadableStream, Response, Vue reactive proxies, etc.).
Adds an optional onBroadcastError callback to BroadcastQueryClientOptions
so consumers can pipe errors to Sentry/Datadog. Falls back to console.warn
in development when the callback is not provided.
Fixes#10543
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix(broadcast-client): guard against throwing onBroadcastError callback
Wrap onBroadcastError() in a try/catch so that if the callback itself
throws, the error does not escape as an unhandled rejection. Falls back
to console.warn in development when the callback throws.
Add a test asserting no unhandledRejection fires when onBroadcastError throws.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix(broadcast-client): handle async onBroadcastError rejections
Support async onBroadcastError callbacks by calling .catch() on the
returned Promise, preventing unhandled rejections when the callback
rejects asynchronously.
Also extracts the console.warn fallback into warnBroadcastError to
deduplicate the warning logic.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* test(broadcast-client): use try/finally to ensure unhandledRejection listener cleanup
Prevents listener leaks into subsequent tests if an assertion throws
before process.off() is reached.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* refactor(broadcast-client): improve types, messages, and docs
- Export BroadcastErrorEvent interface with QueryKey typing so consumers
can import the type directly
- Use discriminated union for internal BroadcastMessage (state only on
updated) for more precise typing
- onBroadcastError now receives BroadcastErrorEvent (no internal state
field) instead of the raw BroadcastMessage
- Differentiate dev warning messages: broadcast failures explain the
structured-clone cause and consequence; onBroadcastError failures
explicitly identify the hook as the source
- Remove warnBroadcastError helper in favour of context-specific inlined
warn calls
- Fix duplicate queryClient.getQueryCache() call (use queryCache directly)
- Add JSDoc to all BroadcastQueryClientOptions fields
- Add onBroadcastError section to broadcastQueryClient docs with Sentry
example
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* test(broadcast-client): assert warn message when onBroadcastError throws or rejects
Add two tests that verify the '[broadcastQueryClient] onBroadcastError
threw while handling...' console.warn message is emitted in development
when the onBroadcastError callback itself throws synchronously or rejects
asynchronously.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix(broadcast-client): include state in 'added' broadcasts
The receiver's onmessage handler reads state for 'added' events to call
query.setState(state) and queryCache.build(..., state), but the sender
was not including state in the outbound message. This caused receiving
tabs to apply undefined state for newly added queries.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* test(broadcast-client): wrap warnSpy in try/finally to prevent spy leakage
If an assertion fails before mockRestore(), the console.warn spy would
leak into subsequent tests. Wrapping each spy block in try/finally
ensures restore always runs regardless of test outcome.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* ci: apply automated fixes
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>