125 lines
1.8 KiB
Markdown
125 lines
1.8 KiB
Markdown
---
|
|
id: MutateOptions
|
|
title: MutateOptions
|
|
---
|
|
|
|
Defined in: [packages/query-core/src/types.ts:1284](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1284)
|
|
|
|
## Type Parameters
|
|
|
|
### TData
|
|
|
|
`TData` = `unknown`
|
|
|
|
### TError
|
|
|
|
`TError` = [`DefaultError`](../type-aliases/DefaultError.md)
|
|
|
|
### TVariables
|
|
|
|
`TVariables` = `void`
|
|
|
|
### TOnMutateResult
|
|
|
|
`TOnMutateResult` = `unknown`
|
|
|
|
## Properties
|
|
|
|
### onError()?
|
|
|
|
```ts
|
|
optional onError: (error, variables, onMutateResult, context) => void;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:1296](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1296)
|
|
|
|
#### Parameters
|
|
|
|
##### error
|
|
|
|
`TError`
|
|
|
|
##### variables
|
|
|
|
`TVariables`
|
|
|
|
##### onMutateResult
|
|
|
|
`TOnMutateResult` | `undefined`
|
|
|
|
##### context
|
|
|
|
[`MutationFunctionContext`](../type-aliases/MutationFunctionContext.md)
|
|
|
|
#### Returns
|
|
|
|
`void`
|
|
|
|
***
|
|
|
|
### onSettled()?
|
|
|
|
```ts
|
|
optional onSettled: (data, error, variables, onMutateResult, context) => void;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:1302](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1302)
|
|
|
|
#### Parameters
|
|
|
|
##### data
|
|
|
|
`TData` | `undefined`
|
|
|
|
##### error
|
|
|
|
`TError` | `null`
|
|
|
|
##### variables
|
|
|
|
`TVariables`
|
|
|
|
##### onMutateResult
|
|
|
|
`TOnMutateResult` | `undefined`
|
|
|
|
##### context
|
|
|
|
[`MutationFunctionContext`](../type-aliases/MutationFunctionContext.md)
|
|
|
|
#### Returns
|
|
|
|
`void`
|
|
|
|
***
|
|
|
|
### onSuccess()?
|
|
|
|
```ts
|
|
optional onSuccess: (data, variables, onMutateResult, context) => void;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:1290](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1290)
|
|
|
|
#### Parameters
|
|
|
|
##### data
|
|
|
|
`TData`
|
|
|
|
##### variables
|
|
|
|
`TVariables`
|
|
|
|
##### onMutateResult
|
|
|
|
`TOnMutateResult` | `undefined`
|
|
|
|
##### context
|
|
|
|
[`MutationFunctionContext`](../type-aliases/MutationFunctionContext.md)
|
|
|
|
#### Returns
|
|
|
|
`void`
|