mutationOptions

Overview#

function mutationOptions<TData, TError, TVariables, TOnMutateResult>(options: WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;
function mutationOptions<TData, TError, TVariables, TOnMutateResult>(options: Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;

• WithRequired<CreateMutationOptions> → WithRequired<CreateMutationOptions>: You can generally pass everything to mutationOptions that you can also pass to createMutation. This overload requires mutationKey, so the resulting options can be looked up elsewhere (e.g. with useMutationState).
• Omit<CreateMutationOptions> → Omit<CreateMutationOptions>: You can generally pass everything to mutationOptions that you can also pass to createMutation.

See also: Parameters · Returns

Call Signature#

function mutationOptions<TData, TError, TVariables, TOnMutateResult>(options: WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;

Defined in: packages/svelte-query/src/mutationOptions.ts:32

You can generally pass everything to mutationOptions that you can also pass to createMutation. This overload requires mutationKey, so the resulting options can be looked up elsewhere (e.g. with useMutationState).

Type Parameters#

TData#

TData = unknown

TError#

TError = Error

TVariables#

TVariables = void

TOnMutateResult#

TOnMutateResult = unknown

Parameters#

options#

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

The options to use — everything you can pass to createMutation, with mutationKey set.

Returns#

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

The same options object.

See#

createMutation to run a mutation with these options.

Example#

Looking the mutation up elsewhere via its mutationKey, e.g. for a global "saving…" indicator:

<script lang="ts">
  import { mutationOptions, useMutationState } from '@tanstack/svelte-query'

  const createPostOptions = mutationOptions({
    mutationKey: ['posts', 'create'],
    mutationFn: createPost,
  })

  const pending = useMutationState({
    filters: { mutationKey: createPostOptions.mutationKey, status: 'pending' },
  })
</script>

{#if pending.length > 0}
  <span>Saving…</span>
{/if}

Call Signature#

function mutationOptions<TData, TError, TVariables, TOnMutateResult>(options: Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;

Defined in: packages/svelte-query/src/mutationOptions.ts:67

You can generally pass everything to mutationOptions that you can also pass to createMutation.

Type Parameters#

TData#

TData = unknown

TError#

TError = Error

TVariables#

TVariables = void

TOnMutateResult#

TOnMutateResult = unknown

Parameters#

options#

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

The options to use — everything you can pass to createMutation.

Returns#

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

The same options object.

See#

createMutation to run a mutation with these options.

Example#

<script lang="ts">
  import { mutationOptions, createMutation } from '@tanstack/svelte-query'

  const createPostOptions = mutationOptions({
    mutationFn: createPost,
  })

  const mutation = createMutation(() => createPostOptions)
</script>

<button onclick={() => mutation.mutate({ title: 'Hello' })}>Create</button>

Parameters#

options#

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

The options to use — everything you can pass to createMutation.

options properties#

Built from MutationObserverOptions. See the type above for what it changes.

Returns#

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

The same options object.

Result properties#

Built from MutationObserverOptions. See the type above for what it changes.