TanStack
API Reference

MutateOptions

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

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

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

Parameters

error

TError

variables

TVariables

onMutateResult

TOnMutateResult | undefined

context

MutationFunctionContext

Returns

void


onSettled()?

ts
optional onSettled: (data, error, variables, onMutateResult, context) => void;

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

Parameters

data

TData | undefined

error

TError | null

variables

TVariables

onMutateResult

TOnMutateResult | undefined

context

MutationFunctionContext

Returns

void


onSuccess()?

ts
optional onSuccess: (data, variables, onMutateResult, context) => void;

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

Parameters

data

TData

variables

TVariables

onMutateResult

TOnMutateResult | undefined

context

MutationFunctionContext

Returns

void