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

CreateMutateFunction

更新于 2026-11-02 Angular 查看英文原文 ↗
TypeScript
1type CreateMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;

定义于:packages/angular-query-experimental/src/types.ts:244

mutate 的类型,由 injectMutation 返回。将变量(以及可选的每次调用专属的 onSuccess/onError/onSettled)透传给底层的 mutate 调用。即发即弃(fire-and-forget)—— 错误通过修改结果暴露,而非由 mutate 抛出,除非 throwOnError 配置为使 injectMutation 在向 ngZone.onError 发射错误后重新抛出该错误。

类型参数

TData

TData = unknown

你的修改函数所解析出的数据类型。

TError

TError = DefaultError

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

TVariables

TVariables = void

传入 mutate 的变量类型。

TOnMutateResult

TOnMutateResult = unknown

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

参数

args

...Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>

返回值

void

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

译自上游 59d11de