UseMutateFunction

1type UseMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;

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

mutate 的类型，由 useMutation 返回。将变量（以及可选的每次调用专属的 onSuccess/onError/onSettled）转发给底层的 mutate 调用。即发即弃（fire-and-forget）—— 错误通过修改结果暴露，而非由 mutate 抛出，除非 throwOnError 使 useMutation 重新抛出错误。

类型参数

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