MutationObserverLoadingResult
定义于:packages/query-core/src/types.ts:2201
当修改正在运行时,处于 pending 状态的修改结果。
继承自
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 |
undefined |
为 undefined,因为修改尚未成功。 |
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 |
true |
为 true,因为修改正在运行。 |
MutationObserverBaseResult.isPending |
isSuccess |
false |
为 false,因为修改尚未成功。 |
MutationObserverBaseResult.isSuccess |
mutate |
MutateFunction<TData, TError, TVariables, TOnMutateResult> |
你可调用的修改函数,传入变量以触发修改,并可选择性地通过额外回调选项挂载钩子。 参数 variables 传入 mutationFn 的变量对象。参数 options.onSuccess 当修改成功时调用此函数,并传入修改的结果。 参数 options.onError 当修改遇到错误时调用此函数,并传入该错误。 参数 options.onSettled 当修改成功或遇到错误时均会调用此函数,并传入数据或错误。 备注 - 若你发起多次请求, onSuccess 仅在你最近一次调用后触发。- 所有回调函数( onSuccess、onError、onSettled)均为无返回值函数,其返回值将被忽略。 |
- |
reset |
() => void |
用于清理修改内部状态的函数(即,将修改重置为其初始状态)。 | - |
status |
"pending" |
为 'pending',因为修改正在运行。 |
MutationObserverBaseResult.status |
submittedAt |
number |
修改提交的时间戳。 | - |
variables |
TVariables |
传入 mutate 的本次修改的变量。 |
MutationObserverBaseResult.variables |