0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/lit/reference/interfaces/DefaultOptions.md
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

2 KiB

id title
DefaultOptions DefaultOptions

Defined in: packages/query-core/src/types.ts:2377

The default options of a QueryClient, applied to every query (queries), mutation (mutations), hydrate, and dehydrate call unless overridden.

Type Parameters

TError

TError = DefaultError

Properties

Property Type Description
dehydrate? DehydrateOptions Default options used when dehydrating the client's caches; see DehydrateOptions.
hydrate? object Default options used when hydrating queries and mutations; see HydrateOptions.
hydrate.deserializeData? TransformerFn Transforms a query's data after it is read from the dehydrated state, reversing serializeData.
hydrate.mutations? MutationOptions<unknown, Error, unknown, unknown> Default options merged into every mutation restored from the dehydrated state.
hydrate.queries? QueryOptions<unknown, Error, unknown, readonly unknown[], never> Default options merged into every query restored from the dehydrated state.
mutations? MutationObserverOptions<unknown, TError, unknown, unknown> Default options applied to every mutation, unless overridden per-mutation.
queries? OmitKeyof<QueryObserverOptions<unknown, TError, unknown, unknown, readonly unknown[], never>, "queryKey" | "suspense", "strictly"> Default options applied to every query, unless overridden per-query.