Class QueueManager<T>

Type Parameters

  • T

Implements

Constructors

constructor

Properties

averageProcessTime highestProcessTime itemsAdded itemsAddedPerSecond itemsProcessed itemsProcessedPerSecond itemsRemoved itemsRemovedPerSecond lowestProcessTime maxQueueSize nextDelay onAdd? onClear? onEmpty? onProcessEnd? onProcessStart? onRemove? processFunction? processInterval resumeOnEmptyTimeout skipProcessOnFull stopOnEmpty waitOnEmpty default

Methods

add clear next peek process remove

Constructors

constructor

Properties

averageProcessTime

averageProcessTime: number = 0

highestProcessTime

highestProcessTime: number = 0

itemsAdded

itemsAdded: number = 0

itemsAddedPerSecond

itemsAddedPerSecond: number = 0

itemsProcessed

itemsProcessed: number = 0

itemsProcessedPerSecond

itemsProcessedPerSecond: number = 0

itemsRemoved

itemsRemoved: number = 0

itemsRemovedPerSecond

itemsRemovedPerSecond: number = 0

lowestProcessTime

lowestProcessTime: number = 0

maxQueueSize

maxQueueSize: number

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

nextDelay

nextDelay: number

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

OptionalonAdd

onAdd?: QueueCallbackFunction<T>

Callback to run when an item is added to the queue

OptionalonClear

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

Callback to run when the queue is cleared

OptionalonEmpty

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

Callback to run when the queue is empty

OptionalonProcessEnd

onProcessEnd?: QueueCallbackFunction<T>

Callback to run when an item is processed

OptionalonProcessStart

onProcessStart?: QueueCallbackFunction<T>

Callback to run when an item is about to be processed

OptionalonRemove

onRemove?: QueueCallbackFunction<T>

Callback to run when an item is removed from the queue

OptionalprocessFunction

processFunction?: QueueCallbackFunction<T>

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

processInterval

processInterval: undefined | Timeout

resumeOnEmptyTimeout

resumeOnEmptyTimeout: undefined | Timeout

skipProcessOnFull

skipProcessOnFull: boolean

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

stopOnEmpty

stopOnEmpty: boolean = false

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

waitOnEmpty

waitOnEmpty: number

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

Static Readonlydefault

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

Methods

add

  • add(item: T): void

    Adds an item to the queue

    Parameters

    • item: T

    Returns void

clear

  • clear(): Promise<void>

    Clears the queue

    Returns Promise<void>

next

  • next(): undefined | T

    Returns undefined | T

peek

  • peek(): undefined | T

    Retrieves the first item in the queue without removing it

    Returns undefined | T

    The first item in the queue

process

  • process(): Promise<undefined | T>

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

    Returns Promise<undefined | T>

remove

  • remove(item: T): undefined | T

    Removes an item from the queue

    Parameters

    • item: T

    Returns undefined | T

Settings

Member Visibility

On This Page

Constructors
Properties
Methods