0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/solid/reference/interfaces/DefaultOptions.md
Wonsuk Choi 6e16d3946a
docs(query-core/utils): add missing JSDoc to utility functions (#11830)
* docs(query-core/utils): add missing JSDoc to utility functions

* docs(query-core/utils): clarify that 'addToEnd' and 'addToStart' drop at most one item

* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:47:14 +09:00

2 KiB

id title
DefaultOptions DefaultOptions

Defined in: packages/solid-query/src/QueryClient.ts:89

The default options a QueryClient applies to every query, with Solid's reconcile option added to queries.

Extends

  • DefaultOptions<TError>

Type Parameters

TError

TError = DefaultError

The default type of errors thrown by queries and mutations using this QueryClient.

Properties

Property Type Description Overrides
dehydrate? DehydrateOptions Default options used when dehydrating the client's caches; see DehydrateOptions. -
hydrate? object Default options used when hydrating queries; 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"> Default options applied to every query, unless overridden per-query. CoreDefaultOptions.queries