Defined in: async-queuer.ts:259
A flexible asynchronous queue for processing tasks with configurable concurrency, priority, and expiration.
Features:
Tasks are processed concurrently up to the configured concurrency limit. When a task completes, the next pending task is processed if the concurrency limit allows.
Error Handling:
State Management:
Example usage:
const asyncQueuer = new AsyncQueuer<string>(async (item) => {
// process item
return item.toUpperCase();
}, {
concurrency: 2,
onSuccess: (result) => {
console.log(result);
}
});
asyncQueuer.addItem('hello');
asyncQueuer.start();
const asyncQueuer = new AsyncQueuer<string>(async (item) => {
// process item
return item.toUpperCase();
}, {
concurrency: 2,
onSuccess: (result) => {
console.log(result);
}
});
asyncQueuer.addItem('hello');
asyncQueuer.start();
• TValue
new AsyncQueuer<TValue>(fn, initialOptions): AsyncQueuer<TValue>
new AsyncQueuer<TValue>(fn, initialOptions): AsyncQueuer<TValue>
Defined in: async-queuer.ts:266
(item) => Promise<any>
AsyncQueuerOptions<TValue> = {}
AsyncQueuer<TValue>
options: AsyncQueuerOptions<TValue>;
options: AsyncQueuerOptions<TValue>;
Defined in: async-queuer.ts:263
readonly store: Store<Readonly<AsyncQueuerState<TValue>>>;
readonly store: Store<Readonly<AsyncQueuerState<TValue>>>;
Defined in: async-queuer.ts:260
addItem(
item,
position,
runOnItemsChange): boolean
addItem(
item,
position,
runOnItemsChange): boolean
Defined in: async-queuer.ts:400
Adds an item to the queue. If the queue is full, the item is rejected and onReject is called. Items can be inserted based on priority or at the front/back depending on configuration.
TValue
QueuePosition = ...
boolean = true
boolean
queuer.addItem({ value: 'task', priority: 10 });
queuer.addItem('task2', 'front');
queuer.addItem({ value: 'task', priority: 10 });
queuer.addItem('task2', 'front');
clear(): void
clear(): void
Defined in: async-queuer.ts:686
Removes all pending items from the queue. Does not affect active tasks.
void
execute(position?): Promise<any>
execute(position?): Promise<any>
Defined in: async-queuer.ts:520
Removes and returns the next item from the queue and executes the task function with it.
Promise<any>
queuer.execute();
// LIFO
queuer.execute('back');
queuer.execute();
// LIFO
queuer.execute('back');
flush(numberOfItems, position?): void
flush(numberOfItems, position?): void
Defined in: async-queuer.ts:555
Processes a specified number of items to execute immediately with no wait time If no numberOfItems is provided, all items will be processed
number = ...
void
getNextItem(position): undefined | TValue
getNextItem(position): undefined | TValue
Defined in: async-queuer.ts:479
Removes and returns the next item from the queue without executing the task function. Use for manual queue management. Normally, use execute() to process items.
QueuePosition = ...
undefined | TValue
// FIFO
queuer.getNextItem();
// LIFO
queuer.getNextItem('back');
// FIFO
queuer.getNextItem();
// LIFO
queuer.getNextItem('back');
peekActiveItems(): TValue[]
peekActiveItems(): TValue[]
Defined in: async-queuer.ts:649
Returns the items currently being processed (active tasks).
TValue[]
peekAllItems(): TValue[]
peekAllItems(): TValue[]
Defined in: async-queuer.ts:642
Returns a copy of all items in the queue, including active and pending items.
TValue[]
peekNextItem(position): undefined | TValue
peekNextItem(position): undefined | TValue
Defined in: async-queuer.ts:632
Returns the next item in the queue without removing it.
QueuePosition = 'front'
undefined | TValue
queuer.peekNextItem(); // front
queuer.peekNextItem('back'); // back
queuer.peekNextItem(); // front
queuer.peekNextItem('back'); // back
peekPendingItems(): TValue[]
peekPendingItems(): TValue[]
Defined in: async-queuer.ts:656
Returns the items waiting to be processed (pending tasks).
TValue[]
reset(): void
reset(): void
Defined in: async-queuer.ts:694
Resets the queuer state to its default values
void
setOptions(newOptions): void
setOptions(newOptions): void
Defined in: async-queuer.ts:298
Updates the queuer options. New options are merged with existing options.
Partial<AsyncQueuerOptions<TValue>>
void
start(): void
start(): void
Defined in: async-queuer.ts:663
Starts processing items in the queue. If already running, does nothing.
void
stop(): void
stop(): void
Defined in: async-queuer.ts:673
Stops processing items in the queue. Does not clear the queue.
void
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.