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, 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>;
    throwOnError?: boolean | ((error) => boolean);
}

Type Parameters

  • TData = unknown

  • TError = DefaultError

  • TVariables = void

  • TContext = unknown

Hierarchy

Properties

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

Properties

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

      Returns unknown

Optional onMutate

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

Type declaration

Optional onSettled

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

Type declaration

    • (data, error, variables, context): unknown

    • Parameters

      Returns unknown

Optional onSuccess

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

Type declaration

Optional retry

retry?: RetryValue<TError>

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional throwOnError

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

Type declaration

    • (error): boolean

    • Parameters

      Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc