Defined in: batcher.ts:56

Options for configuring a Batcher instance

• TValue

optional getShouldExecute: (items, batcher) => boolean;

optional getShouldExecute: (items, batcher) => boolean;

Defined in: batcher.ts:61

Custom function to determine if a batch should be processed Return true to process the batch immediately

TValue[]

Batcher<TValue>

boolean

optional initialState: Partial<BatcherState<TValue>>;

optional initialState: Partial<BatcherState<TValue>>;

Defined in: batcher.ts:65

Initial state for the batcher

optional maxSize: number;

optional maxSize: number;

Defined in: batcher.ts:70

Maximum number of items in a batch

Infinity

Infinity

optional onExecute: (batcher) => void;

optional onExecute: (batcher) => void;

Defined in: batcher.ts:74

Callback fired after a batch is processed

Batcher<TValue>

void

optional onItemsChange: (batcher) => void;

optional onItemsChange: (batcher) => void;

Defined in: batcher.ts:78

Callback fired after items are added to the batcher

Batcher<TValue>

void

optional started: boolean;

optional started: boolean;

Defined in: batcher.ts:83

Whether the batcher should start processing immediately

true

true

optional wait: number | (batcher) => number;

optional wait: number | (batcher) => number;

Defined in: batcher.ts:90

Maximum time in milliseconds to wait before processing a batch. If the wait duration has elapsed, the batch will be processed. If not provided, the batch will not be triggered by a timeout.

Infinity

Infinity