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 e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* docs(query-core): add JSDoc across the package and expose it in generated reference docs

* docs(config.json): add sidebar entries for newly generated query-core reference docs

* docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc

* docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference

* docs(query-core): regenerate reference docs after merging main

* docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type

* fix(query-devtools): drop unnecessary 'query-core' project reference

* docs(query-core): document missing default values and normalize 'Defaults to' spacing

* docs(query-core): fix 'environmentManager' JSDoc example
2026-09-07 18:22:38 +02:00

2.5 KiB

id title
DefaultOptions 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?

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

CoreDefaultOptions.dehydrate

hydrate?

optional hydrate: object;

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

Default options used when hydrating queries; see HydrateOptions.

deserializeData?

optional deserializeData: TransformerFn;

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

mutations?

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

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

queries?

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

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

Inherited from

CoreDefaultOptions.hydrate

mutations?

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

CoreDefaultOptions.mutations

queries?

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

CoreDefaultOptions.queries