TanStack
API Reference

DefaultOptions

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

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

dehydrate?

ts
optional dehydrate: DehydrateOptions;

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

Default options used when dehydrating the client's caches; see DehydrateOptions.

Inherited from

ts
CoreDefaultOptions.dehydrate

hydrate?

ts
optional hydrate: object;

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

Default options used when hydrating queries; see HydrateOptions.

deserializeData?

ts
optional deserializeData: TransformerFn;

Transforms a query's data after it is read from the dehydrated state, reversing serializeData.

mutations?

ts
optional mutations: MutationOptions<unknown, Error, unknown, unknown>;

Default options merged into every mutation restored from the dehydrated state.

queries?

ts
optional queries: QueryOptions<unknown, Error, unknown, readonly unknown[], never>;

Default options merged into every query restored from the dehydrated state.

Inherited from

ts
CoreDefaultOptions.hydrate

mutations?

ts
optional mutations: MutationObserverOptions<unknown, TError, unknown, unknown>;

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

Default options applied to every mutation, unless overridden per-mutation.

Inherited from

ts
CoreDefaultOptions.mutations

queries?

ts
optional queries: OmitKeyof<QueryObserverOptions<unknown, TError, unknown, unknown, readonly unknown[], never>, "queryKey">;

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

Default options applied to every query, unless overridden per-query.

Overrides

ts
CoreDefaultOptions.queries