function useBatchedCallback<TFn>(fn, options): (...args) => void
function useBatchedCallback<TFn>(fn, options): (...args) => void
Defined in: react-pacer/src/batcher/useBatchedCallback.ts:41
A React hook that creates a batched version of a callback function. This hook is essentially a wrapper around the basic batch function that is exported from @tanstack/pacer, but optimized for React with reactive options and a stable function reference.
The batched function will collect individual calls into batches and execute them when batch conditions are met (max size reached, wait time elapsed, or custom logic).
This hook provides a simpler API compared to useBatcher, making it ideal for basic batching needs. However, it does not expose the underlying Batcher instance.
For advanced usage requiring features like:
Consider using the useBatcher hook instead.
• TFn extends AnyFunction
(items) => void
BatcherOptions<Parameters<TFn>[0]>
Function
...Parameters<TFn>
void
// Batch analytics events
const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {
sendAnalytics(events);
}, {
maxSize: 5, // Process when 5 events collected
wait: 2000 // Or after 2 seconds
});
// Use in event handlers
<button onClick={() => trackEvents({ type: 'click', target: 'button' })}>
Click me
</button>
// Batch analytics events
const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {
sendAnalytics(events);
}, {
maxSize: 5, // Process when 5 events collected
wait: 2000 // Or after 2 seconds
});
// Use in event handlers
<button onClick={() => trackEvents({ type: 'click', target: 'button' })}>
Click me
</button>
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.