Defined in: async-queuer.ts:123

A flexible asynchronous queue that processes tasks with configurable concurrency control.

Features:

• Priority queue support via getPriority option
• Configurable concurrency limit
• Task success/error/completion callbacks
• FIFO (First In First Out) or LIFO (Last In First Out) queue behavior
• Pause/resume task processing
• Task cancellation
• Item expiration to clear stale items from the queue

Tasks are processed concurrently up to the configured concurrency limit. When a task completes, the next pending task is processed if below the concurrency limit.

const asyncQueuer = new AsyncQueuer<string>({ concurrency: 2 });

asyncQueuer.addItem(async () => {
  return 'Hello';
});

asyncQueuer.start();

asyncQueuer.onSuccess((result) => {
  console.log(result); // 'Hello'
});

const asyncQueuer = new AsyncQueuer<string>({ concurrency: 2 });

asyncQueuer.addItem(async () => {
  return 'Hello';
});

asyncQueuer.start();

asyncQueuer.onSuccess((result) => {
  console.log(result); // 'Hello'
});

• TValue

new AsyncQueuer<TValue>(initialOptions): AsyncQueuer<TValue>

new AsyncQueuer<TValue>(initialOptions): AsyncQueuer<TValue>

Defined in: async-queuer.ts:137

AsyncQueuerOptions<TValue> = defaultOptions

AsyncQueuer<TValue>

addItem(
   fn, 
   position, 
runOnUpdate): Promise<TValue>

addItem(
   fn, 
   position, 
runOnUpdate): Promise<TValue>

Defined in: async-queuer.ts:324

Adds a task to the queuer

() => Promise<TValue> & object

QueuePosition = ...

boolean = true

Promise<TValue>

clear(): void

clear(): void

Defined in: async-queuer.ts:304

Removes all items from the queuer

void

getActiveItems(): () => Promise<TValue>[]

getActiveItems(): () => Promise<TValue>[]

Defined in: async-queuer.ts:462

Returns the active items

() => Promise<TValue>[]

getAllItems(): () => Promise<TValue>[]

getAllItems(): () => Promise<TValue>[]

Defined in: async-queuer.ts:455

Returns a copy of all items in the queuer

() => Promise<TValue>[]

getExecutionCount(): number

getExecutionCount(): number

Defined in: async-queuer.ts:476

Returns the number of items that have been removed from the queuer

number

getExpirationCount(): number

getExpirationCount(): number

Defined in: async-queuer.ts:538

Returns the number of items that have expired from the queuer

number

getIsEmpty(): boolean

getIsEmpty(): boolean

Defined in: async-queuer.ts:434

Returns true if the queuer is empty

boolean

getIsFull(): boolean

getIsFull(): boolean

Defined in: async-queuer.ts:441

Returns true if the queuer is full

boolean

getIsIdle(): boolean

getIsIdle(): boolean

Defined in: async-queuer.ts:497

Returns true if the queuer is running but has no items to process

boolean

getIsRunning(): boolean

getIsRunning(): boolean

Defined in: async-queuer.ts:490

Returns true if the queuer is running

boolean

getNextItem(position): undefined | () => Promise<TValue>

getNextItem(position): undefined | () => Promise<TValue>

Defined in: async-queuer.ts:398

Removes and returns an item from the queuer

QueuePosition = ...

undefined | () => Promise<TValue>

getOptions(): Required<AsyncQueuerOptions<TValue>>

getOptions(): Required<AsyncQueuerOptions<TValue>>

Defined in: async-queuer.ts:159

Returns the current queuer options

Required<AsyncQueuerOptions<TValue>>

getPeek(position): undefined | () => Promise<TValue>

getPeek(position): undefined | () => Promise<TValue>

Defined in: async-queuer.ts:422

Returns an item without removing it

QueuePosition = 'front'

undefined | () => Promise<TValue>

getPendingItems(): () => Promise<TValue>[]

getPendingItems(): () => Promise<TValue>[]

Defined in: async-queuer.ts:469

Returns the pending items

() => Promise<TValue>[]

getRejectionCount(): number

getRejectionCount(): number

Defined in: async-queuer.ts:483

Returns the number of items that have been rejected from the queuer

number

getSize(): number

getSize(): number

Defined in: async-queuer.ts:448

Returns the current size of the queuer

number

onError(cb): () => void

onError(cb): () => void

Defined in: async-queuer.ts:516

Adds a callback to be called when a task errors

(error) => void

Function

void

onSettled(cb): () => void

onSettled(cb): () => void

Defined in: async-queuer.ts:526

Adds a callback to be called when a task is settled

(result) => void

Function

void

onSuccess(cb): () => void

onSuccess(cb): () => void

Defined in: async-queuer.ts:504

Adds a callback to be called when a task succeeds

(result) => void

Function

void

reset(withInitialItems?): void

reset(withInitialItems?): void

Defined in: async-queuer.ts:312

Resets the queuer to its initial state

boolean

void

setOptions(newOptions): void

setOptions(newOptions): void

Defined in: async-queuer.ts:152

Updates the queuer options Returns the new options state

Partial<AsyncQueuerOptions<TValue>>

void

start(): Promise<void>

start(): Promise<void>

Defined in: async-queuer.ts:272

Starts the queuer and processes items

Promise<void>

stop(): void

stop(): void

Defined in: async-queuer.ts:295

Stops the queuer from processing items

void