Type Alias: MutationResultAccessor<TData, TError, TVariables, TOnMutateResult>#

type MutationResultAccessor<TData, TError, TVariables, TOnMutateResult> = ValueAccessor<MutationObserverResult<TData, TError, TVariables, TOnMutateResult>> & object;

type MutationResultAccessor<TData, TError, TVariables, TOnMutateResult> = ValueAccessor<MutationObserverResult<TData, TError, TVariables, TOnMutateResult>> & object;

Defined in: packages/lit-query/src/createMutationController.ts:38

Accessor returned by createMutationController.

Call the accessor or read its current property to get the latest mutation result. The attached methods delegate to the active mutation observer.

Type Declaration#

destroy()#

destroy: () => void;

destroy: () => void;

Removes the controller from its Lit host and unsubscribes observers.

Returns#

void

mutate()#

mutate: (variables, options?) => void;

mutate: (variables, options?) => void;

Starts the mutation and swallows the returned promise.

Throws synchronously if no QueryClient can be resolved.

Parameters#

variables#

TVariables

options?#

MutateOptions<TData, TError, TVariables, TOnMutateResult>

Returns#

void

mutateAsync#

mutateAsync: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>["mutate"];

mutateAsync: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>["mutate"];

Starts the mutation and returns the observer promise.

Rejects if no QueryClient can be resolved.

reset#

reset: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>["reset"];

reset: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>["reset"];

Resets the mutation observer to its idle state.

Type Parameters#

TData#

TData

TError#

TError

TVariables#

TVariables

TOnMutateResult#

TOnMutateResult