Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PromiseQueue

Hierarchy

  • PromiseQueue

Index

Constructors

Methods

Constructors

constructor

  • new PromiseQueue(__namedParameters?: { concurrency?: number }): PromiseQueue

  • Parameters

    • __namedParameters: { concurrency?: number } = {}
      • Optional concurrency?: number

        The number of tasks that will be executed concurrently. Note that if concurrency > 1, the queue cannot guarantee FIFO since the tasks' execution times may vary.

    Returns PromiseQueue

Methods

addTask

  • addTask<T>(priority: number, task: () => Promise<T>): Promise<T>

  • Add a prioritized task to the queue. Note that a lower priority number means that the task will be prioritized. Ie.: 0 is the highest priority value.

    Type parameters

    • T

    Parameters

    • priority: number
    • task: () => Promise<T>
        • (): Promise<T>

        • Returns Promise<T>

    Returns Promise<T>

getInflight

  • getInflight(): number

getSize

  • getSize(): number

isPaused

  • isPaused(): boolean

pause

  • pause(): void

resume

  • resume(): void