Type Parameters

  • T

Implements

Constructors

Properties

averageProcessTime: number = 0
highestProcessTime: number = 0
itemsAdded: number = 0
itemsAddedPerSecond: number = 0
itemsProcessed: number = 0
itemsProcessedPerSecond: number = 0
itemsRemoved: number = 0
itemsRemovedPerSecond: number = 0
lowestProcessTime: number = 0
maxQueueSize: number

The maximum number of items that can be stored in the queue

nextDelay: number

The amount of time in ms to wait before retrieving the next item in the queue

Callback to run when an item is added to the queue

onClear?: (() => void | Promise<void>)

Callback to run when the queue is cleared

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

onEmpty?: (() => void | Promise<void>)

Callback to run when the queue is empty

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

onProcessEnd?: QueueCallbackFunction<T>

Callback to run when an item is processed

onProcessStart?: QueueCallbackFunction<T>

Callback to run when an item is about to be processed

Callback to run when an item is removed from the queue

processFunction?: QueueCallbackFunction<T>

The function to run on each item in the queue, before continuing to the next item

processInterval: undefined | Timeout
queue: Queue<T>
resumeOnEmptyTimeout: undefined | Timeout
skipProcessOnFull: boolean

Should we skip processing the first item in the queue when it's full and an item is added?

stopOnEmpty: boolean = false

Should we stop processing once the queue is empty, or wait for more items to be added?

waitOnEmpty: number

The amount of time to wait before resuming once the queue is empty

default: {
    maxQueueSize: number;
    nextDelay: number;
    skipProcessOnFull: boolean;
    waitOnEmpty: number;
} = ...

Type declaration

  • maxQueueSize: number
  • nextDelay: number
  • skipProcessOnFull: boolean
  • waitOnEmpty: number

Methods

  • Starts processing the queue, never initialized internally so requires explicit call to start, static queue if never called

    Returns Promise<undefined | T>