mutationOptions
概述
1function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;2function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;WithRequired<CreateMutationOptions>→WithRequired<CreateMutationOptions>：你通常可以向mutationOptions传入所有能传给createMutation的参数。此重载要求提供mutationKey，因此生成的选项可在其他位置查找（例如通过useMutationState）。Omit<CreateMutationOptions>→Omit<CreateMutationOptions>：你通常可以向mutationOptions传入所有能传给createMutation的参数。
调用签名
1function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;定义于：packages/svelte-query/src/mutationOptions.ts:32
你通常可以向 mutationOptions 传入所有能传给 createMutation 的参数。此重载要求提供 mutationKey，因此生成的选项可在其他位置查找（例如通过 useMutationState）。
类型参数
TData
TData = unknown
TError
TError = Error
TVariables
TVariables = void
TOnMutateResult
TOnMutateResult = unknown
参数
options
WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">
要使用的选项 — 即所有可传给 createMutation 的参数，并已设置 mutationKey。
返回值
WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">
相同的选项对象。
参见
使用 createMutation 运行带这些选项的修改。
示例
通过 mutationKey 在其他位置查找该修改，例如用于全局“正在保存…”指示器：
1<script lang="ts">2 import { mutationOptions, useMutationState } from '@tanstack/svelte-query'3 4 const createPostOptions = mutationOptions({5 mutationKey: ['posts', 'create'],6 mutationFn: createPost,7 })8 9 const pending = useMutationState({10 filters: { mutationKey: createPostOptions.mutationKey, status: 'pending' },11 })12</script>13 14{#if pending.length > 0}15 <span>Saving…</span>16{/if}调用签名
1function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;定义于：packages/svelte-query/src/mutationOptions.ts:67
你通常可以向 mutationOptions 传入所有能传给 createMutation 的参数。
类型参数
TData
TData = unknown
TError
TError = Error
TVariables
TVariables = void
TOnMutateResult
TOnMutateResult = unknown
参数
options
Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">
要使用的选项 — 即所有可传给 createMutation 的参数。
返回值
Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">
相同的选项对象。
参见
使用 createMutation 运行带这些选项的修改。
示例
1<script lang="ts">2 import { mutationOptions, createMutation } from '@tanstack/svelte-query'3 4 const createPostOptions = mutationOptions({5 mutationFn: createPost,6 })7 8 const mutation = createMutation(() => createPostOptions)9</script>10 11<button onclick={() => mutation.mutate({ title: 'Hello' })}>Create</button>参数
options
Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">
要使用的选项 — 即所有可传给 createMutation 的参数。
options 属性
基于 MutationObserverOptions 构建。请参阅上方类型定义以了解其变更内容。
返回值
Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">
相同的选项对象。
返回值属性
基于 MutationObserverOptions 构建。请参阅上方类型定义以了解其变更内容。