API Reference

MutationObserverBaseResult

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

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

Extends

MutationState<TData, TError, TVariables, TOnMutateResult>

Extended by

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

TVariables

TVariables = void

TOnMutateResult

TOnMutateResult = unknown

Properties

Property	Type	Description	Overrides
context	TOnMutateResult \| undefined	The value returned by onMutate, if defined. Passed to onSuccess, onError and onSettled as the mutation's context.	-
data	TData \| undefined	The last successfully resolved data for the mutation.	MutationState.data
error	TError \| null	The error object for the mutation, if an error was encountered. - Defaults to null.	MutationState.error
failureCount	number	The number of times the mutation function has failed for the current attempt.	-
failureReason	TError \| null	The reason the current attempt failed, as reported by the retryer.	-
isError	boolean	A boolean variable derived from status. - true if the last mutation attempt resulted in an error.	-
isIdle	boolean	A boolean variable derived from status. - true if the mutation is in its initial state prior to executing.	-
isPaused	boolean	Whether the mutation is currently paused (see network mode), or is waiting for another mutation with the same scope to finish.	-
isPending	boolean	A boolean variable derived from status. - true if the mutation is currently executing.	-
isSuccess	boolean	A boolean variable derived from status. - true if the last mutation attempt was successful.	-
mutate	MutateFunction<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	() => void	A function to clean the mutation internal state (i.e., it resets the mutation to its initial state).	-
status	"error" \| "pending" \| "success" \| "idle"	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.	MutationState.status
submittedAt	number	The timestamp for when the mutation was submitted.	-
variables	TVariables \| undefined	The variables object passed to the mutationFn.	MutationState.variables

PreviousInterfaces / MutationFilters

NextInterfaces / MutationObserverErrorResult