PacedMutationsConfig

Defined in: packages/db/src/paced-mutations.ts:17

Configuration for creating a paced mutations manager

Type Parameters#

TVariables#

TVariables = unknown

T#

T extends object = Record<string, unknown>

Properties#

metadata?#

optional metadata: Record<string, unknown>;

Defined in: packages/db/src/paced-mutations.ts:39

Custom metadata to associate with transactions

mutationFn#

mutationFn: MutationFn<T>;

Defined in: packages/db/src/paced-mutations.ts:30

Function to execute the mutation on the server. Receives the transaction parameters containing all merged mutations.

onMutate()#

onMutate: (variables) => void;

Defined in: packages/db/src/paced-mutations.ts:25

Callback to apply optimistic updates immediately. Receives the variables passed to the mutate function.

Parameters#

variables#

TVariables

Returns#

void

strategy#

strategy: Strategy;

Defined in: packages/db/src/paced-mutations.ts:35

Strategy for controlling mutation execution timing Examples: debounceStrategy, queueStrategy, throttleStrategy