0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/lit/reference/interfaces/MutationObserverErrorResult.md
2026-10-09 15:50:46 +00:00

4.4 KiB

id title
MutationObserverErrorResult MutationObserverErrorResult

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

A mutation result in the error state after the mutation failed.

Extends

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 undefined undefined, since the mutation hasn't succeeded. MutationObserverBaseResult.data
error TError The error the mutation failed with. MutationObserverBaseResult.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 true true, since the mutation failed. MutationObserverBaseResult.isError
isIdle false false, since the mutation has run. MutationObserverBaseResult.isIdle
isPaused boolean Whether the mutation is currently paused (see network mode), or is waiting for another mutation with the same scope to finish. -
isPending false false, since the mutation isn't running. MutationObserverBaseResult.isPending
isSuccess false false, since the mutation hasn't succeeded. MutationObserverBaseResult.isSuccess
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 variables The variables object to pass to the mutationFn. Param options.onSuccess This function will fire when the mutation is successful and will be passed the mutation's result. Param options.onError This function will fire if the mutation encounters an error and will be passed the error. Param options.onSettled 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" 'error', since the mutation failed. MutationObserverBaseResult.status
submittedAt number The timestamp for when the mutation was submitted. -
variables TVariables The variables passed to mutate for this mutation. MutationObserverBaseResult.variables