Class AsyncQueue<T>

Async queue.

param: The worker function to call for each task.
param: How many workers to run in parrallel. Must be greater than 0.
returns: The async queue object.

Type parameters

T

Element type of the queue.

Hierarchy

AsyncQueue

Index

Constructors

constructor

Properties

Accessors

started

Methods

Constructors

constructor

new AsyncQueue(worker: IWorker<T>, concurrency?: number): AsyncQueue

- Defined in async/AsyncQueue.ts:64
Parameters
- worker: IWorker<T>
- Default value concurrency: number = 1
Returns AsyncQueue

Properties

concurrency

concurrency: number

onDrain

onDrain: Signal<OnDrainSignal> = new Signal<OnDrainSignal>()

onEmpty

onEmpty: Signal<OnEmptySignal> = new Signal<OnEmptySignal>()

onError

onError: Signal<OnErrorSignal<T>> = new Signal<OnErrorSignal<T>>()

onSaturated

onSaturated: Signal<OnSaturatedSignal> = new Signal<OnSaturatedSignal>()

onUnsaturated

onUnsaturated: Signal<OnUnsaturatedSignal> = new Signal<OnUnsaturatedSignal>()

worker

worker: IWorker<T>

Accessors

started

get started(): boolean

- Defined in async/AsyncQueue.ts:74
Returns boolean

Methods

getTask

getTask(index: number): ITask<T>

- Defined in async/AsyncQueue.ts:150
Parameters
- index: number
Returns ITask<T>

idle

idle(): boolean

- Defined in async/AsyncQueue.ts:122
Returns boolean

length

length(): number

- Defined in async/AsyncQueue.ts:112
Returns number

pause

pause(): void

- Defined in async/AsyncQueue.ts:127
Returns void

process

process(): void

- Defined in async/AsyncQueue.ts:94
Returns void

push

push(data: T, callback?: IItemCallback): void

- Defined in async/AsyncQueue.ts:84
Parameters
- data: T
- Optional callback: IItemCallback
Returns void

reset

reset(): void

- Defined in async/AsyncQueue.ts:76
Returns void

resume

resume(): void

- Defined in async/AsyncQueue.ts:135
Returns void

running

running(): number

- Defined in async/AsyncQueue.ts:117
Returns number

unshift

unshift(data: T, callback?: IItemCallback): void

- Defined in async/AsyncQueue.ts:89
Parameters
- data: T
- Optional callback: IItemCallback
Returns void

Generated using TypeDoc