TanStack
Query v5v5
API Reference

MutationObserverErrorResult

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

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

Extends

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

TVariables

TVariables = void

TOnMutateResult

TOnMutateResult = unknown

Properties

PropertyTypeDescriptionOverrides
contextTOnMutateResult | undefinedThe value returned by onMutate, if defined. Passed to onSuccess, onError and onSettled as the mutation's context.-
dataundefinedThe last successfully resolved data for the mutation.MutationObserverBaseResult.data
errorTErrorThe error object for the mutation, if an error was encountered. - Defaults to null.MutationObserverBaseResult.error
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.-
isErrortrueA boolean variable derived from status. - true if the last mutation attempt resulted in an error.MutationObserverBaseResult.isError
isIdlefalseA boolean variable derived from status. - true if the mutation is in its initial state prior to executing.MutationObserverBaseResult.isIdle
isPausedbooleanWhether the mutation is currently paused (see network mode), or is waiting for another mutation with the same scope to finish.-
isPendingfalseA boolean variable derived from status. - true if the mutation is currently executing.MutationObserverBaseResult.isPending
isSuccessfalseA boolean variable derived from status. - true if the last mutation attempt was successful.MutationObserverBaseResult.isSuccess
mutateMutateFunction<TData, TError, TVariables, TOnMutateResult>The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options. Param The variables object to pass to the mutationFn. Param This function will fire when the mutation is successful and will be passed the mutation's result. Param This function will fire if the mutation encounters an error and will be passed the error. Param This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error. Remarks - If you make multiple requests, onSuccess will fire only after the latest call you've made. - All the callback functions (onSuccess, onError, onSettled) are void functions, and the returned value will be ignored.-
reset() => voidA function to clean the mutation internal state (i.e., it resets the mutation to its initial state).-
status"error"The status of the mutation. - Will be: - idle initial status prior to the mutation function executing. - pending if the mutation is currently executing. - error if the last mutation attempt resulted in an error. - success if the last mutation attempt was successful.MutationObserverBaseResult.status
submittedAtnumberThe timestamp for when the mutation was submitted.-
variablesTVariablesThe variables object passed to the mutationFn.MutationObserverBaseResult.variables
Edit on GitHub
Interfaces / MutationObserverBaseResult
Interfaces / MutationObserverIdleResult
© 2026 TanStack LLC