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