API Documentation / @pinia/colada / defineMutationOptions

Function: defineMutationOptions()

Define type-safe mutation options. Can be static or dynamic. Define the arguments based on what's needed. Use an object if you need multiple properties.

Param

setupOrOptions

The mutation options or a function that returns the mutation options.

Example

import { defineMutationOptions } from '@pinia/colada'

const deleteItemMutation = defineMutationOptions({
  mutation: (id: number) => fetch(`/api/items/${id}`, { method: 'DELETE' }),
})

// use in a component
const { mutate } = useMutation(deleteItemMutation)

@NO_SIDE_EFFECTS

Call Signature

function defineMutationOptions<Params, TData, TVars, TError, TContext>(setupOptions): (params?) => DefineMutationOptionsTagged<TData, TVars, TError, TContext>;

Define dynamic mutation options by passing a function that accepts an optional arbitrary parameter and returns the mutation options. Pass to useMutation directly: useMutation(setupOptions(params)).

Type Parameters

Params

Params

TData

TData

TVars

TVars = void

TError

TError = { custom: Error; }

TContext

TContext extends Record<any, any> = _EmptyObject

Parameters

setupOptions

(params?) => UseMutationOptions<TData, TVars, TError, TContext>

A function that returns the mutation options.

Returns

(params?) => DefineMutationOptionsTagged<TData, TVars, TError, TContext>

Call Signature

function defineMutationOptions<Params, TData, TVars, TError, TContext>(setupOptions): (params) => DefineMutationOptionsTagged<TData, TVars, TError, TContext>;

Define dynamic mutation options by passing a function that accepts an arbitrary parameter and returns the mutation options. Pass to useMutation directly: useMutation(setupOptions(params)).

Type Parameters

Params

Params

TData

TData

TVars

TVars = void

TError

TError = { custom: Error; }

TContext

TContext extends Record<any, any> = _EmptyObject

Parameters

setupOptions

(params) => UseMutationOptions<TData, TVars, TError, TContext>

A function that returns the mutation options.

Returns

(params) => DefineMutationOptionsTagged<TData, TVars, TError, TContext>

Call Signature

function defineMutationOptions<TData, TVars, TError, TContext>(options): DefineMutationOptionsTagged<TData, TVars, TError, TContext>;

Define static mutation options that can be passed directly to useMutation.

Type Parameters

TData

TData

TVars

TVars = void

TError

TError = { custom: Error; }

TContext

TContext extends Record<any, any> = _EmptyObject

Parameters

options

UseMutationOptions<TData, TVars, TError, TContext>

The mutation options.

Returns

DefineMutationOptionsTagged<TData, TVars, TError, TContext>