API Documentation / @pinia/colada / useMutation

Function: useMutation()

function useMutation<TData, TVars, TError, TContext>(options): UseMutationReturn<TData, TVars, TError, TContext>;

Setups a mutation.

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>

Options to create the mutation

Returns

UseMutationReturn<TData, TVars, TError, TContext>

Example

const queryCache = useQueryCache()
const { mutate, status, error } = useMutation({
  mutation: (id: number) => fetch(`/api/todos/${id}`),
  onSuccess() {
    queryCache.invalidateQueries('todos')
  },
})