Class PriorityQueue

A class representing a priority queue for async functions.

Hierarchy

PriorityQueue

Implements

IQueue<(() => Promise<unknown>), IPriorityQueueOptions>

Index

Constructors

Properties

Accessors

Methods

dequeue enqueue filter

Constructors

constructor

new PriorityQueue(): PriorityQueue
Returns PriorityQueue

Properties

`Protected` `Readonly` queue

queue: (IPriorityQueueOptions & {
run: (() => Promise<unknown>);
})[] = []

Queue of functions to run

Accessors

size

get size(): number
Get the number of functions in the queue

Returns number
Implementation of IQueue.size
- Defined in packages/util/src/queue/PriorityQueue.ts:18

Methods

dequeue

dequeue(): undefined | (() => Promise<unknown>)
Remove a function from the queue

Returns undefined | (() => Promise<unknown>)
Implementation of IQueue.dequeue
- Defined in packages/util/src/queue/PriorityQueue.ts:51

enqueue

enqueue(run, options?): void
Add a function to the queue
Parameters
- run: (() => Promise<unknown>)
  
  Function to run
  - - (): Promise<unknown>
    - Returns Promise<unknown>
- Optional options: Partial<IPriorityQueueOptions>
  
  Options for the queue
Returns void
Implementation of IQueue.enqueue
- Defined in packages/util/src/queue/PriorityQueue.ts:27

filter

filter(options): (() => Promise<unknown>)[]
Get the functions with the given priority.
Parameters
- options: Readonly<Partial<IPriorityQueueOptions>>
  
  Options for the queue
Returns (() => Promise<unknown>)[]
Implementation of IQueue.filter
- Defined in packages/util/src/queue/PriorityQueue.ts:60

Generated using TypeDoc