Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

DefaultOptions.md

29 lines2.0 KB

1---
2id: DefaultOptions
3title: DefaultOptions
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8Defined in: [packages/query-core/src/types.ts:2378](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L2378)
9​
10The default options of a `QueryClient`, applied to every query (`queries`), mutation
11(`mutations`), `hydrate`, and `dehydrate` call unless overridden.
12​
13## Type Parameters
14​
15### TError
16​
17`TError` = [`DefaultError`](../type-aliases/DefaultError.md)
18​
19## Properties
20​
21| Property | Type | Description |
22| ------ | ------ | ------ |
23| <a id="property-dehydrate"></a> `dehydrate?` | [`DehydrateOptions`](DehydrateOptions.md) | Default options used when dehydrating the client's caches; see [DehydrateOptions](DehydrateOptions.md). |
24| <a id="property-hydrate"></a> `hydrate?` | `object` | Default options used when hydrating queries and mutations; see [HydrateOptions](HydrateOptions.md). |
25| `hydrate.deserializeData?` | `TransformerFn` | Transforms a query's `data` after it is read from the dehydrated state, reversing `serializeData`. |
26| `hydrate.mutations?` | [`MutationOptions`](MutationOptions.md)\<`unknown`, `Error`, `unknown`, `unknown`\> | Default options merged into every mutation restored from the dehydrated state. |
27| `hydrate.queries?` | [`QueryOptions`](QueryOptions.md)\<`unknown`, `Error`, `unknown`, readonly `unknown`[], `never`\> | Default options merged into every query restored from the dehydrated state. |
28| <a id="property-mutations"></a> `mutations?` | [`MutationObserverOptions`](MutationObserverOptions.md)\<`unknown`, `TError`, `unknown`, `unknown`\> | Default options applied to every mutation, unless overridden per-mutation. |
29| <a id="property-queries"></a> `queries?` | [`OmitKeyof`](../type-aliases/OmitKeyof.md)\<[`QueryObserverOptions`](QueryObserverOptions.md)\<`unknown`, `TError`, `unknown`, `unknown`, readonly `unknown`[], `never`\>, `"queryKey"` \| `"suspense"`, `"strictly"`\> | Default options applied to every query, unless overridden per-query. |