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

UseMutateAsyncFunction

更新于 2026-11-02 React 查看英文原文 ↗
TypeScript
1type UseMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = MutateFunction<TData, TError, TVariables, TOnMutateResult>;

定义于:packages/react-query/src/types.ts:437

mutateAsync 的类型,由 useMutation 返回。与 UseMutateFunction 类似,但返回一个可被 await 的 Promise。

类型参数

TData

TData = unknown

你的修改函数所解析(resolve)的数据类型。

TError

TError = DefaultError

你的修改函数可能抛出的错误类型。

TVariables

TVariables = void

传入 mutateAsync 的变量类型。

TOnMutateResult

TOnMutateResult = unknown

onMutate 所返回的类型,将作为 onSuccess/onError/onSettled 的 onMutateResult 参数传入——适用于乐观更新(optimistic update)回滚数据。

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

译自上游 59d11de