MutateFunction

type MutateFunction<TData, TError, TVariables, TOnMutateResult> = (...rest: MutateFunctionRest<TData, TError, TVariables, TOnMutateResult>) => Promise<TData>;

Defined in: packages/query-core/src/types.ts:2072

The mutate function of a MutationObserver: runs the mutation with the given variables and resolves with its data.

Type Parameters#

TData#

TData = unknown

TError#

TError = DefaultError

TVariables#

TVariables = void

TOnMutateResult#

TOnMutateResult = unknown

Parameters#

rest#

...MutateFunctionRest<TData, TError, TVariables, TOnMutateResult>

Returns#

Promise<TData>