Function: injectMutation()

function injectMutation<TData, TError, TVariables, TOnMutateResult>(injectMutationFn, options?): CreateMutationResult<TData, TError, TVariables, TOnMutateResult>;

Defined in: inject-mutation.ts:45

Injects a mutation: an imperative function that can be invoked which typically performs server side effects.

Unlike queries, mutations are not run automatically.

Type Parameters

TData

TData = unknown

TError

TError = Error

TVariables

TVariables = void

TOnMutateResult

TOnMutateResult = unknown

Parameters

injectMutationFn

() => CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>

A function that returns mutation options.

options?

InjectMutationOptions

Additional configuration

Returns

CreateMutationResult<TData, TError, TVariables, TOnMutateResult>

The mutation.