Interface MutationObserverBaseResult<TData, TError, TVariables, TContext>

interface MutationObserverBaseResult {
    context: undefined | TContext;
    data: undefined | TData;
    error: null | TError;
    failureCount: number;
    failureReason: null | TError;
    isError: boolean;
    isIdle: boolean;
    isLoading: boolean;
    isPaused: boolean;
    isSuccess: boolean;
    mutate: MutateFunction<TData, TError, TVariables, TContext>;
    reset: (() => void);
    status: MutationStatus;
    variables: undefined | TVariables;
}

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

Properties

context data error failureCount failureReason isError isIdle isLoading isPaused isSuccess mutate reset status variables

Properties

context

context: undefined | TContext

data

data: undefined | TData

error

error: null | TError

failureCount

failureCount: number

failureReason

failureReason: null | TError

isError

isError: boolean

isIdle

isIdle: boolean

isLoading

isLoading: boolean

isPaused

isPaused: boolean

isSuccess

isSuccess: boolean

mutate

mutate: MutateFunction<TData, TError, TVariables, TContext>

reset

reset: (() => void)

Type declaration

    • (): void

    • Returns void

status

status: MutationStatus

variables

variables: undefined | TVariables

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc