译零 TransZero · TanStack Query 中文文档
主站

MutationObserverBaseResult

更新于 2026-11-02 Lit 查看英文原文 ↗

定义于：packages/query-core/src/types.ts:2085

每个修改结果状态所共有的属性，例如 data、error、variables、status、is* 标志、mutate 和 reset。

继承自

被以下类型扩展

类型参数

TData

TData = unknown

TError

TError = DefaultError

TVariables

TVariables = void

TOnMutateResult

TOnMutateResult = unknown

属性

属性 类型 描述 重写自
context TOnMutateResult | undefined 若已定义 onMutate，则为其返回值；该值将作为修改的上下文传入 onSuccess、onError 和 onSettled。 -
data TData | undefined 修改最后一次成功解析的数据。 MutationState.data
error TError | null 修改的错误对象（若发生错误）。- 默认为 null。 MutationState.error
failureCount number 当前尝试中修改函数失败的次数。 -
failureReason TError | null 当前尝试失败的原因（由重试器报告）。 -
isError boolean 一个由 status 推导出的布尔变量。- 若最后一次修改尝试发生错误，则为 true。 -
isIdle boolean 一个由 status 推导出的布尔变量。- 若修改处于执行前的初始状态，则为 true。 -
isPaused boolean 修改当前是否已暂停（参见网络模式），或是否正在等待另一个具有相同 scope 的修改完成。 -
isPending boolean 一个由 status 推导出的布尔变量。- 若修改当前正在执行，则为 true。 -
isSuccess boolean 一个由 status 推导出的布尔变量。- 若最后一次修改尝试成功，则为 true。 -
mutate MutateFunction<TData, TError, TVariables, TOnMutateResult> 你可调用的修改函数，传入变量以触发修改，并可选择性地通过额外回调选项挂载钩子。
参数 variables 传入 mutationFn 的变量对象。
参数 options.onSuccess 修改成功时调用此函数，并传入修改结果。
参数 options.onError 修改遇到错误时调用此函数，并传入错误。
参数 options.onSettled 修改成功或遇到错误时均会调用此函数，并传入数据或错误。
备注 - 若你发起多次请求，onSuccess 仅在你最近一次调用完成后触发。
- 所有回调函数（onSuccess、onError、onSettled）均为 void 函数，其返回值将被忽略。		 -
reset () => void 用于清理修改内部状态的函数（即，将修改重置为其初始状态）。 -
status "error" | "pending" | "success" | "idle" 修改的状态。
- 取值为：
- idle：修改函数执行前的初始状态；
- pending：修改当前正在执行；
- error：最后一次修改尝试发生错误；
- success：最后一次修改尝试成功。		 MutationState.status
submittedAt number 修改提交的时间戳。 -
variables TVariables | undefined 传入 mutationFn 的变量对象。 MutationState.variables

本页为 TanStack Query 文档（Lit 版）的非官方中文翻译，原文由上游团队维护，遵循 MIT 许可。 译文如有偏差，以英文原文为准。

译自上游 59d11de