* 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>
* docs(example): dataloader
* use tanstack pacer instead of dataloader
* add staleTime
* switch to useAsyncBatchedCallback
* Revert "switch to useAsyncBatchedCallback"
This reverts commit 4d408daa63.
* fix: use PromiseWithResolvers
* add batching example to docs
* 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>
* docs(solid-query/useQuery): document 'throwOnError' default value
* docs(solid-query/useQuery): document SSR and 'suspense' exceptions to 'throwOnError' default
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
* 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>
`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>
Inlining a `select` on a query object passed to `useQueries` /
`useSuspenseQueries` can't infer its `data` argument from the sibling
`queryFn` and falls back to `unknown` — a known TypeScript limitation
(TanStack/query#6556).
Document the two workarounds (annotate the `select` parameter, or define
the query with the `queryOptions` helper) in the React docs, and add type
tests guarding the behavior. Scoped to React for an easier review; the
other framework adapters can follow the same pattern in separate PRs.
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>