Constructor MutationOptions

Namespace

Velvet

Assembly

Velvet.Docs.dll

MutationOptions(Func<TVariables, CancellationToken, VelvetTask<TData>>, Func<TVariables, VelvetTask<TContext>>?, Func<TData, TVariables, TContext?, VelvetTask>?, Func<Exception, TVariables, TContext?, VelvetTask>?, Func<TData?, Exception?, TVariables, TContext?, VelvetTask>?)

Options passed to UseMutation<TVariables, TData, TContext>(MutationOptions<TVariables, TData, TContext>): TanStack Query's onMutate / onSuccess / onError / onSettled quartet. OnMutate runs before MutationFn, and what it returns is the context each later callback of that call receives — the place to snapshot and write an optimistic value, roll it back in OnError, and finish in OnSettled. Where OnMutate throws or its task faults, or the options declare none, the callbacks receive a default context. Every callback returns a task the call waits for before the next stage, OnMutate included, so a context built from a request is the task's result.

public MutationOptions(Func<TVariables, CancellationToken, VelvetTask<TData>> MutationFn, Func<TVariables, VelvetTask<TContext>>? OnMutate = null, Func<TData, TVariables, TContext?, VelvetTask>? OnSuccess = null, Func<Exception, TVariables, TContext?, VelvetTask>? OnError = null, Func<TData?, Exception?, TVariables, TContext?, VelvetTask>? OnSettled = null)

Parameters

MutationFn Func<TVariables, CancellationToken, VelvetTask<TData>>

OnMutate Func<TVariables, VelvetTask<TContext>>

OnSuccess Func<TData, TVariables, TContext, VelvetTask>

OnError Func<Exception, TVariables, TContext, VelvetTask>

OnSettled Func<TData, Exception, TVariables, TContext, VelvetTask>