Interface MutationOptions<TData, TError, TVariables, TContext>

interface MutationOptions<TData, TError, TVariables, TContext> {
    _defaulted?: boolean;
    gcTime?: number;
    meta?: Record<string, unknown>;
    mutationFn?: MutationFunction<TData, TVariables>;
    mutationKey?: MutationKey;
    networkMode?: NetworkMode;
    onError?: ((error, variables, context) => unknown);
    onMutate?: ((variables) => undefined | TContext | Promise<undefined | TContext>);
    onSettled?: ((data, error, variables, context) => unknown);
    onSuccess?: ((data, variables, context) => unknown);
    retry?: RetryValue<TError>;
    retryDelay?: RetryDelayValue<TError>;
}

Type Parameters

TData = unknown
TError = DefaultError
TVariables = void
TContext = unknown

Hierarchy (view full)

MutationOptions
- MutationObserverOptions

Index

Properties

_defaulted? gcTime? meta? mutationFn? mutationKey? networkMode? onError? onMutate? onSettled? onSuccess? retry? retryDelay?

Properties

`Optional` _defaulted

_defaulted?: boolean

`Optional` gcTime

gcTime?: number

`Optional` meta

meta?: Record<string, unknown>

`Optional` mutationFn

mutationFn?: MutationFunction<TData, TVariables>

`Optional` mutationKey

mutationKey?: MutationKey

`Optional` networkMode

networkMode?: NetworkMode

`Optional` onError

onError?: ((error, variables, context) => unknown)

Type declaration

- (error, variables, context): unknown
- Parameters
  - error: TError
  - variables: TVariables
  - context: undefined | TContext
  Returns unknown

`Optional` onMutate

onMutate?: ((variables) => undefined | TContext | Promise<undefined | TContext>)

Type declaration

- (variables): undefined | TContext | Promise<undefined | TContext>
- Parameters
  - variables: TVariables
  Returns undefined | TContext | Promise<undefined | TContext>

`Optional` onSettled

onSettled?: ((data, error, variables, context) => unknown)

Type declaration

- (data, error, variables, context): unknown
- Parameters
  - data: undefined | TData
  - error: null | TError
  - variables: TVariables
  - context: undefined | TContext
  Returns unknown

`Optional` onSuccess

onSuccess?: ((data, variables, context) => unknown)

Type declaration

- (data, variables, context): unknown
- Parameters
  - data: TData
  - variables: TVariables
  - context: TContext
  Returns unknown

`Optional` retry

retry?: RetryValue<TError>

`Optional` retryDelay

retryDelay?: RetryDelayValue<TError>

Generated using TypeDoc