Documentation
Framework
Version

BaseMutationNarrowing

Interface: BaseMutationNarrowing<TData, TError, TVariables, TOnMutateResult>

Defined in: types.ts:183

Type Parameters

TData = unknown

TError = DefaultError

TVariables = unknown

TOnMutateResult = unknown

Properties

isError

isError: SignalFunction<
  (this) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TOnMutateResult,
    Override<
      MutationObserverErrorResult<TData, TError, TVariables, TOnMutateResult>,
      {
        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
      }
    > & {
      mutateAsync: CreateMutateAsyncFunction<
        TData,
        TError,
        TVariables,
        TOnMutateResult
      >
    }
  >
>
isError: SignalFunction<
  (this) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TOnMutateResult,
    Override<
      MutationObserverErrorResult<TData, TError, TVariables, TOnMutateResult>,
      {
        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
      }
    > & {
      mutateAsync: CreateMutateAsyncFunction<
        TData,
        TError,
        TVariables,
        TOnMutateResult
      >
    }
  >
>

Defined in: types.ts:206


isIdle

isIdle: SignalFunction<
  (this) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TOnMutateResult,
    Override<
      MutationObserverIdleResult<TData, TError, TVariables, TOnMutateResult>,
      {
        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
      }
    > & {
      mutateAsync: CreateMutateAsyncFunction<
        TData,
        TError,
        TVariables,
        TOnMutateResult
      >
    }
  >
>
isIdle: SignalFunction<
  (this) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TOnMutateResult,
    Override<
      MutationObserverIdleResult<TData, TError, TVariables, TOnMutateResult>,
      {
        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
      }
    > & {
      mutateAsync: CreateMutateAsyncFunction<
        TData,
        TError,
        TVariables,
        TOnMutateResult
      >
    }
  >
>

Defined in: types.ts:240


isPending

isPending: SignalFunction<
  (this) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TOnMutateResult,
    Override<
      MutationObserverLoadingResult<TData, TError, TVariables, TOnMutateResult>,
      {
        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
      }
    > & {
      mutateAsync: CreateMutateAsyncFunction<
        TData,
        TError,
        TVariables,
        TOnMutateResult
      >
    }
  >
>
isPending: SignalFunction<
  (this) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TOnMutateResult,
    Override<
      MutationObserverLoadingResult<TData, TError, TVariables, TOnMutateResult>,
      {
        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
      }
    > & {
      mutateAsync: CreateMutateAsyncFunction<
        TData,
        TError,
        TVariables,
        TOnMutateResult
      >
    }
  >
>

Defined in: types.ts:223


isSuccess

isSuccess: SignalFunction<
  (this) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TOnMutateResult,
    Override<
      MutationObserverSuccessResult<TData, TError, TVariables, TOnMutateResult>,
      {
        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
      }
    > & {
      mutateAsync: CreateMutateAsyncFunction<
        TData,
        TError,
        TVariables,
        TOnMutateResult
      >
    }
  >
>
isSuccess: SignalFunction<
  (this) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TOnMutateResult,
    Override<
      MutationObserverSuccessResult<TData, TError, TVariables, TOnMutateResult>,
      {
        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
      }
    > & {
      mutateAsync: CreateMutateAsyncFunction<
        TData,
        TError,
        TVariables,
        TOnMutateResult
      >
    }
  >
>

Defined in: types.ts:189