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

defaultShouldDehydrateMutation.md

29 lines695 Bytes

1---
2id: defaultShouldDehydrateMutation
3title: defaultShouldDehydrateMutation
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8```ts
9function defaultShouldDehydrateMutation(mutation: Mutation): boolean;
10```
11​
12Defined in: [packages/query-core/src/hydration.ts:209](https://github.com/TanStack/query/blob/main/packages/query-core/src/hydration.ts#L209)
13​
14The default `shouldDehydrateMutation` predicate used by `dehydrate`. Only dehydrates mutations that are
15currently paused (e.g. paused by `networkMode` while offline).
16​
17## Parameters
18​
19### mutation
20​
21[`Mutation`](../classes/Mutation.md)
22​
23The mutation to check.
24​
25## Returns
26​
27`boolean`
28​
29`true` if the mutation is paused.