TanStack
API Reference

MutationObserverResult

ts
type MutationObserverResult<TData, TError, TVariables, TOnMutateResult> = 
  | MutationObserverIdleResult<TData, TError, TVariables, TOnMutateResult>
  | MutationObserverLoadingResult<TData, TError, TVariables, TOnMutateResult>
  | MutationObserverErrorResult<TData, TError, TVariables, TOnMutateResult>
| MutationObserverSuccessResult<TData, TError, TVariables, TOnMutateResult>;

Defined in: packages/query-core/src/types.ts:2346

The result of a MutationObserver, and of the hooks built on it like useMutation. Narrow it by status or the is* flags to get the type of each state.

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

TVariables

TVariables = void

TOnMutateResult

TOnMutateResult = unknown