Function: mutationOptions()

function mutationOptions<TData, TError, TVariables, TOnMutateResult>(options): MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>;

function mutationOptions<TData, TError, TVariables, TOnMutateResult>(options): MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>;

Defined in: packages/lit-query/src/mutationOptions.ts:22

Preserves and types mutation options for reuse across Lit Query APIs.

Type Parameters

TData

TData = unknown

TError

TError = Error

TVariables

TVariables = void

TOnMutateResult

TOnMutateResult = unknown

Parameters

options

MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>

Mutation options to preserve.

Returns

MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>

The same options object.

Example

import { mutationOptions } from '@tanstack/lit-query'

const addTodoOptions = mutationOptions({
  mutationKey: ['add-todo'],
  mutationFn: (title: string) => addTodo(title),
})

import { mutationOptions } from '@tanstack/lit-query'

const addTodoOptions = mutationOptions({
  mutationKey: ['add-todo'],
  mutationFn: (title: string) => addTodo(title),
})

mutationOptions

Function: mutationOptions()#

Type Parameters#

TData#

TError#

TVariables#

TOnMutateResult#

Parameters#

options#

Returns#

Example#

Want to Skip the Docs?