AsyncBatcherOptions

Defined in: async-batcher.ts:89

Options for configuring an AsyncBatcher instance

Type Parameters

TValue

TValue

Properties

asyncRetryerOptions?

optional asyncRetryerOptions?: AsyncRetryerOptions<(items) => Promise<any>>;

Defined in: async-batcher.ts:93

Options for configuring the underlying async retryer

getShouldExecute?

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

Defined in: async-batcher.ts:100

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

Parameters

items

TValue[]

batcher

AsyncBatcher<TValue>

Returns

boolean

initialState?

optional initialState?: Partial<AsyncBatcherState<TValue>>;

Defined in: async-batcher.ts:107

Initial state for the async batcher

key?

optional key?: string;

Defined in: async-batcher.ts:112

Optional key to identify this async batcher instance. If provided, the async batcher will be identified by this key in the devtools and PacerProvider if applicable.

maxSize?

optional maxSize?: number;

Defined in: async-batcher.ts:117

Maximum number of items in a batch

Default

Infinity

onError?

optional onError?: (error, batch, batcher) => void;

Defined in: async-batcher.ts:123

Optional error handler for when the batch function throws. If provided, the handler will be called with the error, the batch of items that failed, and batcher instance. This can be used alongside throwOnError - the handler will be called before any error is thrown.

Parameters

error

Error

batch

TValue[]

batcher

AsyncBatcher<TValue>

Returns

void

onItemsChange?

optional onItemsChange?: (batcher) => void;

Defined in: async-batcher.ts:131

Callback fired after items are added to the batcher

Parameters

batcher

AsyncBatcher<TValue>

Returns

void

onSettled?

optional onSettled?: (batch, batcher) => void;

Defined in: async-batcher.ts:135

Optional callback to call when a batch is settled (completed or failed)

Parameters

batch

TValue[]

batcher

AsyncBatcher<TValue>

Returns

void

onSuccess?

optional onSuccess?: (result, batch, batcher) => void;

Defined in: async-batcher.ts:139

Optional callback to call when a batch succeeds

Parameters

result

any

batch

TValue[]

batcher

AsyncBatcher<TValue>

Returns

void

started?

optional started?: boolean;

Defined in: async-batcher.ts:148

Whether the batcher should start processing immediately

Default

true

throwOnError?

optional throwOnError?: boolean;

Defined in: async-batcher.ts:154

Whether to throw errors when they occur. Defaults to true if no onError handler is provided, false if an onError handler is provided. Can be explicitly set to override these defaults.

wait?

optional wait?: number | ((asyncBatcher) => number);

Defined in: async-batcher.ts:161

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.

Default

Infinity