MutationOptions

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

Extended by#

• MutationObserverOptions

Type Parameters#

TData#

TData = unknown

TError#

TError = DefaultError

TVariables#

TVariables = void

TOnMutateResult#

TOnMutateResult = unknown

Properties#

gcTime?#

optional gcTime: number;

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

The time in milliseconds that an unused/inactive mutation remains in memory before it is garbage collected.

Defaults to 5 * 60 * 1000 (5 minutes), or Infinity during SSR.

meta?#

optional meta: Record<string, unknown>;

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

mutationFn?#

optional mutationFn: MutationFunction<TData, TVariables>;

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

mutationKey?#

optional mutationKey: readonly unknown[];

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

networkMode?#

optional networkMode: NetworkMode;

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

Controls whether a mutation is allowed to run based on the current network connectivity.

Defaults to 'online'.

See#

Network Mode for more information.

onError()?#

optional onError: (error, variables, onMutateResult, context) => unknown;

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

Parameters#

error#

TError

variables#

TVariables

onMutateResult#

TOnMutateResult | undefined

context#

MutationFunctionContext

Returns#

unknown

onMutate()?#

optional onMutate: (variables, context) => TOnMutateResult | Promise<TOnMutateResult>;

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

Parameters#

variables#

TVariables

context#

MutationFunctionContext

Returns#

TOnMutateResult | Promise<TOnMutateResult>

onSettled()?#

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

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

Parameters#

data#

TData | undefined

error#

TError | null

variables#

TVariables

onMutateResult#

TOnMutateResult | undefined

context#

MutationFunctionContext

Returns#

unknown

onSuccess()?#

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

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

Parameters#

data#

TData

variables#

TVariables

onMutateResult#

TOnMutateResult

context#

MutationFunctionContext

Returns#

unknown

retry?#

optional retry: RetryValue<TError>;

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

If false, failed mutations will not retry by default. If true, failed mutations will retry infinitely. If set to an integer number, e.g. 3, failed mutations will retry until the failed mutation count meets that number. If set to a function (failureCount, error) => boolean failed mutations will retry until the function returns false.

Defaults to 0.

retryDelay?#

optional retryDelay: RetryDelayValue<TError>;

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

This function receives a retryAttempt integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.

Defaults to a function that applies exponential backoff, capped at 30 seconds.

scope?#

optional scope: MutationScope;

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