TanStack
Query v5v5
API Reference

MutationState

Defined in: packages/query-core/src/mutation.ts:30

The raw state stored on a Mutation instance. This is the underlying state that observer results (e.g. MutationObserverResult) are derived from.

Extended by

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

TVariables

TVariables = unknown

TOnMutateResult

TOnMutateResult = unknown

Properties

PropertyTypeDescription
contextTOnMutateResult | undefinedThe value returned by onMutate, if defined. Passed to onSuccess, onError and onSettled as the mutation's context.
dataTData | undefinedThe last successfully resolved data for the mutation.
errorTError | nullThe error object for the mutation, if the last attempt resulted in an error. - Defaults to null.
failureCountnumberThe number of times the mutation function has failed for the current attempt.
failureReasonTError | nullThe reason the current attempt failed, as reported by the retryer.
isPausedbooleanWhether the mutation is currently paused (see network mode), or is waiting for another mutation with the same scope to finish.
status"error" | "pending" | "success" | "idle"The status of the mutation.
submittedAtnumberThe timestamp for when the mutation was submitted.
variablesTVariables | undefinedThe variables the mutation was last called with.
Edit on GitHub
Interfaces / MutationOptions
Interfaces / NotifyEvent
© 2026 TanStack LLC