Defined in: async-queuer.ts:80

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

Features:

• Priority queuer support via getPriority option
• Configurable concurrency limit
• Task success/error/completion callbacks
• FIFO (First In First Out) or LIFO (Last In First Out) queuer behavior
• Pause/resume task processing
• Task cancellation

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 queuer = new AsyncQueuer<string>({ concurrency: 2 });

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

queuer.start();

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

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

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

queuer.start();

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

• TValue

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

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

Defined in: async-queuer.ts:91

AsyncQueuerOptions<TValue> = defaultOptions

AsyncQueuer<TValue>

protected options: Required<AsyncQueuerOptions<TValue>>;

protected options: Required<AsyncQueuerOptions<TValue>>;

Defined in: async-queuer.ts:81

addItem(fn, position): Promise<TValue>

addItem(fn, position): Promise<TValue>

Defined in: async-queuer.ts:174

Adds a task to the queuer

() => Promise<TValue>

"front" | "back"

Promise<TValue>

clear(): void

clear(): void

Defined in: async-queuer.ts:282

Removes all items from the queuer

void

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

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

Defined in: async-queuer.ts:316

Returns the active items

() => Promise<TValue>[]

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

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

Defined in: async-queuer.ts:302

Returns a copy of all items in the queuer

() => Promise<TValue>[]

getExecutionCount(): number

getExecutionCount(): number

Defined in: async-queuer.ts:309

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

number

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

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

Defined in: async-queuer.ts:227

Removes and returns an item from the queuer

"front" | "back"

undefined | () => Promise<TValue>

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

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

Defined in: async-queuer.ts:323

Returns the pending items

() => Promise<TValue>[]

isEmpty(): boolean

isEmpty(): boolean

Defined in: async-queuer.ts:261

Returns true if the queuer is empty

boolean

isFull(): boolean

isFull(): boolean

Defined in: async-queuer.ts:268

Returns true if the queuer is full

boolean

isIdle(): boolean

isIdle(): boolean

Defined in: async-queuer.ts:399

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

boolean

isRunning(): boolean

isRunning(): boolean

Defined in: async-queuer.ts:392

Returns true if the queuer is running

boolean

onError(cb): () => void

onError(cb): () => void

Defined in: async-queuer.ts:340

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:350

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:330

Adds a callback to be called when a task succeeds

(result) => void

Function

void

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

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

Defined in: async-queuer.ts:249

Returns an item without removing it

"front" | "back"

undefined | () => Promise<TValue>

reset(withInitialItems?): void

reset(withInitialItems?): void

Defined in: async-queuer.ts:290

Resets the queuer to its initial state

boolean

void

setOptions(newOptions): AsyncQueuerOptions<TValue>

setOptions(newOptions): AsyncQueuerOptions<TValue>

Defined in: async-queuer.ts:111

Updates the queuer options Returns the new options state

Partial<AsyncQueuerOptions<TValue>>

AsyncQueuerOptions<TValue>

size(): number

size(): number

Defined in: async-queuer.ts:275

Returns the current size of the queuer

number

start(): Promise<void>

start(): Promise<void>

Defined in: async-queuer.ts:360

Starts the queuer and processes items

Promise<void>

stop(): void

stop(): void

Defined in: async-queuer.ts:383

Stops the queuer from processing items

void

throttle(n): void

throttle(n): void

Defined in: async-queuer.ts:406

Throttles the number of concurrent items that can run at once

number

void

protected tick(): void

protected tick(): void

Defined in: async-queuer.ts:121

Processes items in the queuer

void