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

MutationCacheConfig

更新于 2026-11-02 Svelte 查看英文原文 ↗

定义于:packages/query-core/src/mutationCache.ts:26

作用于 MutationCache 所处理的每个修改的全局回调函数,无论该修改由哪个组件或观察者触发。它们与传递给 QueryClient 的 defaultOptions 有两点不同:一是 defaultOptions 可被每个修改单独覆盖,而这些回调始终会被调用;二是此处的 onMutate 不允许返回结果。

若某个回调返回一个 Promise,则该 Promise 将在修改继续执行前被 await。

属性

属性 类型 描述
onError? (error: Error, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => unknown 当缓存中的任意修改遇到错误时调用。
onMutate? (variables: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => unknown 在缓存中的任意修改执行前调用。
onSettled? (data: unknown, error: Error | null, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => unknown 当缓存中的任意修改完成(无论成功或失败)时调用。
onSuccess? (data: unknown, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => unknown 当缓存中的任意修改成功时调用。

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

译自上游 59d11de