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

mutationOptions

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

概述

TypeScript
1function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: WithRequired<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): WithRequired<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;2function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;
  • WithRequired<MutationOptions> → WithRequired<MutationOptions>:你通常可以向 mutationOptions 传入任何能传给 useMutation 的参数。此重载要求提供一个 mutationKey,以便后续查找该修改(例如通过 useMutationState)。
  • Omit<MutationOptions> → Omit<MutationOptions>:你通常可以向 mutationOptions 传入任何能传给 useMutation 的参数。此重载无需 mutationKey —— 当你后续不需要通过 mutationKey 过滤器定位该修改时(例如通过 useMutationState),请使用此形式;它仍可通过其他过滤器(如 status)被观察。

另请参阅:参数 · 返回值

调用签名

TypeScript
1function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: WithRequired<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): WithRequired<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;

定义于:packages/solid-query/src/mutationOptions.ts:31

你通常可以向 mutationOptions 传入任何能传给 useMutation 的参数。此重载要求提供一个 mutationKey,以便后续查找该修改(例如通过 useMutationState)。

类型参数

TData

TData = unknown

TError

TError = Error

TVariables

TVariables = void

TOnMutateResult

TOnMutateResult = unknown

参数

options

WithRequired<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">

要使用的修改选项,与传给 useMutation 的选项完全相同,但必须包含 mutationKey。

返回值

WithRequired<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">

原始选项对象,未作更改。

参阅

useMutation 用于执行这些选项所描述的修改。

示例

在其他位置通过其 mutationKey 查找该修改(例如实现全局“保存中…”指示器):

TypeScript
1import { mutationOptions, useMutationState } from '@tanstack/solid-query'2 3const createPostOptions = mutationOptions({4  mutationKey: ['posts', 'create'],5  mutationFn: createPost,6})7 8function SavingIndicator() {9  const isCreatingPost = useMutationState(() => ({10    filters: { mutationKey: createPostOptions.mutationKey, status: 'pending' },11  }))12 13  return isCreatingPost().length > 0 ? <span>Saving…</span> : null14}

调用签名

TypeScript
1function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;

定义于:packages/solid-query/src/mutationOptions.ts:69

你通常可以向 mutationOptions 传入任何能传给 useMutation 的参数。此重载无需 mutationKey —— 当你后续不需要通过 mutationKey 过滤器定位该修改时(例如通过 useMutationState),请使用此形式;它仍可通过其他过滤器(如 status)被观察。

类型参数

TData

TData = unknown

TError

TError = Error

TVariables

TVariables = void

TOnMutateResult

TOnMutateResult = unknown

参数

options

Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">

要使用的修改选项,与传给 useMutation 的选项完全相同,但不包含 mutationKey。

返回值

Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">

原始选项对象,未作更改。

备注

有关通过 useMutationState 查找修改的示例,请参阅另一重载的示例。

参阅

useMutation 用于执行这些选项所描述的修改。

示例

TypeScript
1import { mutationOptions, useMutation } from '@tanstack/solid-query'2 3const createPostOptions = mutationOptions({4  mutationFn: createPost,5})6 7function CreatePost() {8  const createPostMutation = useMutation(() => createPostOptions)9  return <button onClick={() => createPostMutation.mutate({ title: 'Hello' })}>Create</button>10}

参数

options

Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">

要使用的修改选项,与传给 useMutation 的选项完全相同,但不包含 mutationKey。

options 属性

基于 MutationOptions 构建。请参阅上方类型说明以了解其变更内容。

返回值

Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">

原始选项对象,未作更改。

返回值属性

基于 MutationOptions 构建。请参阅上方类型说明以了解其变更内容。

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

译自上游 59d11de