UseBaseMutationResult
TypeScript
1type UseBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TOnMutateResult>, {2 mutate: UseMutateFunction<TData, TError, TVariables, TOnMutateResult>;3}> & object;定义于:packages/react-query/src/types.ts:453
useMutation 的返回结果。与 @tanstack/query-core 中的 MutationObserverResult 相同,但将 mutate 窄化为「即发即弃」(fire-and-forget)风格的 UseMutateFunction 签名,并额外添加了 mutateAsync。
类型参数
TData
TData = unknown
你的修改函数所解析(resolve)的数据类型。
TError
TError = DefaultError
你的修改函数可能抛出的错误类型。
TVariables
TVariables = unknown
传入 mutate/mutateAsync 的变量类型。
TOnMutateResult
TOnMutateResult = unknown
onMutate 所返回的类型,将作为 onSuccess/onError/onSettled 的 onMutateResult 参数传入——适用于乐观更新回滚所需的数据。
类型声明
mutateAsync
TypeScript
1mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult>;与 mutate 类似,但返回一个可被 await 的 Promise。