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

MutationResultAccessor

更新于 2026-11-02 Lit 查看英文原文 ↗
TypeScript
1type MutationResultAccessor<TData, TError, TVariables, TOnMutateResult> = ValueAccessor<MutationObserverResult<TData, TError, TVariables, TOnMutateResult>> & object;

定义于:packages/lit-query/src/createMutationController.ts:34

由 createMutationController 返回的访问器。

调用该访问器,或读取其 current 属性,即可获取最新的修改结果。所附带的方法会委托给当前活跃的修改观察者(mutation observer)。

类型参数

TData

TData

TError

TError

TVariables

TVariables

TOnMutateResult

TOnMutateResult

类型声明

destroy

TypeScript
1destroy: () => void;

从 Lit 宿主中移除该控制器,并取消订阅所有观察者。

返回值

void

mutate

TypeScript
1mutate: (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;

启动修改,并静默处理返回的 Promise(即不抛出异常)。

若无法解析出 QueryClient,则同步抛出错误。

参数

args

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

返回值

void

mutateAsync

TypeScript
1mutateAsync: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>["mutate"];

启动修改并返回观察者 Promise。

若无法解析出 QueryClient,则拒绝该 Promise。

reset

TypeScript
1reset: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>["reset"];

将修改观察者重置为其空闲(idle)状态。

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

译自上游 59d11de