function useAsyncQueuer<TValue>(options): object
function useAsyncQueuer<TValue>(options): object
Defined in: react-pacer/src/async-queuer/useAsyncQueuer.ts:54
A lower-level React hook that creates an AsyncQueuer instance for managing an async queue of items.
This hook provides a flexible, state-management agnostic way to handle queued async operations. It returns a queuer instance with methods to add items, control queue execution, and monitor queue state.
The queue can be configured with:
The hook returns an object containing methods to:
• TValue
AsyncQueuerOptions<TValue> = {}
object
addItem: (fn, position?) => Promise<TValue>;
addItem: (fn, position?) => Promise<TValue>;
Adds a task to the queuer
() => Promise<TValue>
"front" | "back"
Promise<TValue>
clear: () => void;
clear: () => void;
Removes all items from the queuer
void
getActiveItems: () => () => Promise<TValue>[];
getActiveItems: () => () => Promise<TValue>[];
Returns the active items
() => Promise<TValue>[]
getAllItems: () => () => Promise<TValue>[];
getAllItems: () => () => Promise<TValue>[];
Returns a copy of all items in the queuer
() => Promise<TValue>[]
getExecutionCount: () => number;
getExecutionCount: () => number;
Returns the number of items that have been removed from the queuer
number
getNextItem: (position?) => undefined | () => Promise<TValue>;
getNextItem: (position?) => undefined | () => Promise<TValue>;
Removes and returns an item from the queuer
"front" | "back"
undefined | () => Promise<TValue>
getPendingItems: () => () => Promise<TValue>[];
getPendingItems: () => () => Promise<TValue>[];
Returns the pending items
() => Promise<TValue>[]
isEmpty: () => boolean;
isEmpty: () => boolean;
Returns true if the queuer is empty
boolean
isFull: () => boolean;
isFull: () => boolean;
Returns true if the queuer is full
boolean
isIdle: () => boolean;
isIdle: () => boolean;
Returns true if the queuer is running but has no items to process
boolean
isRunning: () => boolean;
isRunning: () => boolean;
Returns true if the queuer is running
boolean
onError: (cb) => () => void;
onError: (cb) => () => void;
Adds a callback to be called when a task errors
(error) => void
Function
void
onSettled: (cb) => () => void;
onSettled: (cb) => () => void;
Adds a callback to be called when a task is settled
(result) => void
Function
void
onSuccess: (cb) => () => void;
onSuccess: (cb) => () => void;
Adds a callback to be called when a task succeeds
(result) => void
Function
void
peek: (position?) => undefined | () => Promise<TValue>;
peek: (position?) => undefined | () => Promise<TValue>;
Returns an item without removing it
"front" | "back"
undefined | () => Promise<TValue>
reset: (withInitialItems?) => void;
reset: (withInitialItems?) => void;
Resets the queuer to its initial state
boolean
void
size: () => number;
size: () => number;
Returns the current size of the queuer
number
start: () => Promise<void>;
start: () => Promise<void>;
Starts the queuer and processes items
Promise<void>
stop: () => void;
stop: () => void;
Stops the queuer from processing items
void
throttle: (n) => void;
throttle: (n) => void;
Throttles the number of concurrent items that can run at once
number
void
// Basic async queuer for API requests
const asyncQueuer = useAsyncQueuer({
initialItems: [],
concurrency: 2,
maxSize: 100,
started: false,
});
// Add items to queue
asyncQueuer.addItem(newItem);
// Start processing
asyncQueuer.start();
// Monitor queue state
const isPending = !asyncQueuer.isIdle();
const itemCount = asyncQueuer.size();
// Handle results
asyncQueuer.onSuccess((result) => {
console.log('Item processed:', result);
});
asyncQueuer.onError((error) => {
console.error('Processing failed:', error);
});
// Basic async queuer for API requests
const asyncQueuer = useAsyncQueuer({
initialItems: [],
concurrency: 2,
maxSize: 100,
started: false,
});
// Add items to queue
asyncQueuer.addItem(newItem);
// Start processing
asyncQueuer.start();
// Monitor queue state
const isPending = !asyncQueuer.isIdle();
const itemCount = asyncQueuer.size();
// Handle results
asyncQueuer.onSuccess((result) => {
console.log('Item processed:', result);
});
asyncQueuer.onError((error) => {
console.error('Processing failed:', error);
});
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.