Function: batch()

function batch<TValue>(fn, options): (item) => void;

function batch<TValue>(fn, options): (item) => void;

Defined in: batcher.ts:323

Creates a batcher that processes items in batches.

This synchronous version is lighter weight and often all you need - upgrade to asyncBatch when you need promises, retry support, abort/cancel capabilities, or advanced error handling.

Type Parameters

TValue

Parameters

fn

() =>

options

Returns

(item): void;

(item): void;

Adds an item to the batcher If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed

Parameters

item

Returns

Example

const batchItems = batch<number>(
  (items) => console.log('Processing:', items),
  {
    maxSize: 3,
    onExecute: (batch, batcher) => console.log('Batch executed:', batch)
  }
);

batchItems(1);
batchItems(2);
batchItems(3); // Triggers batch processing

const batchItems = batch<number>(
  (items) => console.log('Processing:', items),
  {
    maxSize: 3,
    onExecute: (batch, batcher) => console.log('Batch executed:', batch)
  }
);

batchItems(1);
batchItems(2);
batchItems(3); // Triggers batch processing

batch

Function: batch()#

Type Parameters#

TValue#

Parameters#

fn#

options#

Returns#

Parameters#

item#

Returns#

Example#

Function: batch()

Type Parameters

TValue

Parameters

fn

options

Returns

Parameters

item

Returns

Example