UseMutateFunction

type UseMutateFunction<TData, TError, TVariables, TOnMutateResult> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;

Defined in: packages/solid-query/src/types.ts:276

The type of mutate, as returned by useMutation. Forwards the variables (and an optional per-call onSuccess/onError/onSettled) to the underlying mutate call. Fire-and-forget — errors are surfaced through the mutation result instead of being thrown by mutate, unless throwOnError makes useMutation rethrow them.

Type Parameters#

TData#

TData = unknown

The type your mutation function resolves to.

TError#

TError = DefaultError

The type of errors your mutation function may throw.

TVariables#

TVariables = void

The type of the variable passed to mutate.

TOnMutateResult#

TOnMutateResult = unknown

The type returned by onMutate, passed to onSuccess/onError/onSettled as their onMutateResult parameter — useful for optimistic-update rollback data.

Parameters#

args#

...Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>

Returns#

void