Interface UseMutationOptions<TData, TError, TVariables, TContext>

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

Type Parameters

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

Hierarchy (view full)

Properties

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

Properties

OptionalgcTime

gcTime?: number

Optionalmeta

meta?: Record<string, unknown>

OptionalmutationFn

mutationFn?: MutationFunction<TData, TVariables>

OptionalmutationKey

mutationKey?: MutationKey

OptionalnetworkMode

networkMode?: NetworkMode

OptionalonError

onError?: ((error: TError, variables: TVariables, context: undefined | TContext) => unknown)

OptionalonMutate

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

OptionalonSettled

onSettled?: ((data: undefined | TData, error: null | TError, variables: TVariables, context: undefined | TContext) => unknown)

OptionalonSuccess

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

Optionalretry

retry?: RetryValue<TError>

OptionalretryDelay

retryDelay?: RetryDelayValue<TError>

Optionalscope

scope?: MutationScope

OptionalthrowOnError

throwOnError?: boolean | ((error: TError) => boolean)

Settings

Member Visibility

On This Page

Properties