Interface IPromiseQueueOptions<QueueType, QueueOptions>

Type Parameters

Hierarchy

Properties

autoStart? carryoverConcurrencyCount? concurrency? interval? intervalCap? queueClass? throwOnTimeout? timeout?

Properties

Optional Readonly autoStart

autoStart?: boolean

Whether queue tasks within concurrency limit, are auto-executed as soon as they're added.

Default

true

Optional Readonly carryoverConcurrencyCount

carryoverConcurrencyCount?: boolean

Whether the task must finish in the given interval or will be carried over into the next interval count.

Default

false

Optional Readonly concurrency

concurrency?: number

Concurrency limit. Minimum: 1.

Default

Infinity

Optional Readonly interval

interval?: number

The length of time in milliseconds before the interval count resets. Must be finite. Minimum: 0.

Default

0

Optional Readonly intervalCap

intervalCap?: number

The max number of runs in the given interval of time. Minimum: 1.

Default

Infinity

Optional Readonly queueClass

queueClass?: (new () => QueueType)

Type declaration

    • new (): QueueType

    • Class with a enqueue and dequeue method, and a size getter. See the Custom QueueClass section.

      Returns QueueType

Optional throwOnTimeout

throwOnTimeout?: boolean

Whether or not a timeout is considered an exception.

Default

false

Optional timeout

timeout?: number

Per-operation timeout in milliseconds. Operations fulfill once timeout elapses if they haven't already.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc