useAsyncBatchedCallback

function useAsyncBatchedCallback<TValue>(fn, options): (item) => Promise<any>;

function useAsyncBatchedCallback<TValue>(fn, options): (item) => Promise<any>;

Defined in: async-batcher/useAsyncBatchedCallback.ts:36

Returns a stable batched callback owned by the Octane lifecycle.

Collects items until maxSize, wait, or getShouldExecute triggers a batch. Each call adds one item; the wrapped function receives an array.

Return value

Returns the bound addItem method, which accepts one item per call. The returned Promise preserves the core result and error contract. An addition that only schedules a batch does not await the later batch result.

State and ownership

Use useAsyncBatcher when you need selected state or control methods. This callback does not expose the utility, its store, or a child subscription.

Call during component rendering. The hook retains its utility across renders and runs cleanup when the component unmounts. Options accept an object with top-level getters or an options factory. Function-valued core options remain callbacks. Local options override provider defaults without replacing the utility or its pending work. onUnmount replaces default cleanup and receives the utility instance. A custom callback must perform every needed cancel, stop, or abort action.

Type Parameters

TValue

TValue

Parameters

fn

(items) => Promise<any>

options

OctanePacerOptions<OctaneAsyncBatcherOptions<TValue, { }>>

Returns

(item): Promise<any>;

(item): Promise<any>;

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

Parameters

item

TValue

Returns

Promise<any>

The result from the batch function, or undefined if an error occurred and was handled by onError

Throws

The error from the batch function if no onError handler is configured or throwOnError is true

Example

import { useAsyncBatchedCallback } from '@tanstack/octane-pacer'

// During component rendering:
const schedule = useAsyncBatchedCallback(async (items: Array<number>) => { console.log(items) }, { maxSize: 5, wait: 500 })
void schedule(1)

import { useAsyncBatchedCallback } from '@tanstack/octane-pacer'

// During component rendering:
const schedule = useAsyncBatchedCallback(async (items: Array<number>) => { console.log(items) }, { maxSize: 5, wait: 500 })
void schedule(1)

See

useAsyncBatcher