Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutateResourceOptions<ResourceData, SourceData, TError, TContext>

Type Parameters

  • ResourceData = unknown

  • SourceData = ResourceData

  • TError = unknown

  • TContext = unknown

Hierarchy

  • MutationOptions<ResourceData, SourceData, TError, TContext>
    • MutateResourceOptions

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

key

key: string

Optional meta

meta?: MutationMeta

Optional mutationFn

mutationFn?: MutationFunction<ResourceData, SourceData>

Optional mutationKey

mutationKey?: MutationKey

Optional overrideGlobalOnError

overrideGlobalOnError?: boolean

Optional requestConfig

requestConfig?: RequestConfig

Optional retry

retry?: RetryValue<TError>

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional variables

variables?: SourceData

Methods

Optional onError

  • onError(error: TError, variables: TVariables, context: undefined | TContext): void | Promise<unknown>

  • Parameters

    • error: TError
    • variables: TVariables
    • context: undefined | TContext

    Returns void | Promise<unknown>

Optional onMutate

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

  • Parameters

    • variables: TVariables

    Returns undefined | TContext | Promise<undefined | TContext>

Optional onSettled

  • onSettled(data: undefined | TData, error: null | TError, variables: TVariables, context: undefined | TContext): void | Promise<unknown>

  • Parameters

    • data: undefined | TData
    • error: null | TError
    • variables: TVariables
    • context: undefined | TContext

    Returns void | Promise<unknown>

Optional onSuccess

  • onSuccess(data: TData, variables: TVariables, context: undefined | TContext): void | Promise<unknown>

  • Parameters

    • data: TData
    • variables: TVariables
    • context: undefined | TContext

    Returns void | Promise<unknown>

Generated using TypeDoc