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#
| Property | Type | Description |
|---|
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. |
error | TError | null | The error object for the mutation, if the last attempt resulted in an error. - Defaults to null. |
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. |
isPaused | boolean | Whether the mutation is currently paused (see network mode), or is waiting for another mutation with the same scope to finish. |
status | "error" | "idle" | "pending" | "success" | The status of the mutation. |
submittedAt | number | The timestamp for when the mutation was submitted. |
variables | TVariables | undefined | The variables the mutation was last called with. |