API Reference

MutateOptions

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

The callbacks that can be passed to mutate for a single call. They run after the callbacks of the mutation options.

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

TVariables

TVariables = void

TOnMutateResult

TOnMutateResult = unknown

Properties

Property	Type	Description
onError?	(error: TError, variables: TVariables, onMutateResult: TOnMutateResult \| undefined, context: MutationFunctionContext) => void	Called when the mutation of this call fails, after the onError of the mutation options.
onSettled?	(data: TData \| undefined, error: TError \| null, variables: TVariables, onMutateResult: TOnMutateResult \| undefined, context: MutationFunctionContext) => void	Called when the mutation of this call succeeds or fails, after the onSettled of the mutation options.
onSuccess?	(data: TData, variables: TVariables, onMutateResult: TOnMutateResult \| undefined, context: MutationFunctionContext) => void	Called when the mutation of this call succeeds, after the onSuccess of the mutation options.

PreviousInterfaces / InvalidateQueryFilters

NextInterfaces / MutationCacheConfig