Class PromiseQueue

A queue that processes promises with a given concurrency and delays after each promise if desired.

Index

Constructors

Methods

add clear close

Constructors

constructor

new PromiseQueue(concurrency?, delay?): PromiseQueue
Parameters
- concurrency: number = 1
- delay: number = 0
Returns PromiseQueue
- Defined in packages/general/src/util/PromiseQueue.ts:22

Methods

add

add<T>(executor): Promise<T>
Add a promise to the queue. It returns a promise that can be awaited.
Type Parameters
- T
Parameters
- executor: (() => Promise<T>)
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>
- Defined in packages/general/src/util/PromiseQueue.ts:30

clear

clear(reject): void
Clear the queue.
Parameters
- reject: boolean
Returns void
- Defined in packages/general/src/util/PromiseQueue.ts:87

close

close(): void
Close the queue and remove all outstanding promises (but do not reject them).

Returns void
- Defined in packages/general/src/util/PromiseQueue.ts:99