Skip to content

PacedMutationsConfig.md

Latest commit

 

History

History
81 lines (48 loc) · 1.63 KB

PacedMutationsConfig.md

File metadata and controls

81 lines (48 loc) · 1.63 KB
id PacedMutationsConfig
title PacedMutationsConfig

Interface: PacedMutationsConfig<TVariables, T>

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

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:30

Custom metadata to associate with transactions

mutationFn

mutationFn: MutationFn<T>;

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

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:16

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:26

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