Class default<T>

A queue implementation where the reader promises block until new data is available.

Type Parameters

T

Index

Constructors

Accessors

data length pendingPromiseCount

Methods

add cancelPendingPromises clear remove compareFn

Constructors

constructor

new default<T>(
    maxDataQueueLength?: number,
    maxPendingPromiseCount?: number,
    defaultTimeout?: number,
): default<T>
Constructs a new priority queue.
Type Parameters
- T
Parameters
- maxDataQueueLength: number = Number.POSITIVE_INFINITY
- maxPendingPromiseCount: number = Number.POSITIVE_INFINITY
- defaultTimeout: number = Number.POSITIVE_INFINITY
  Default timeout used for remove() call when no timeout was specified. Defaults to Number.POSITIVE_INFINITY.
Returns default<T>
- Defined in misc/BlockingPriorityQueue.ts:17

Accessors

data

get data(): T[]
Get a copy of the internal data buffer.

Note that the elements themselves are not copied, so if the contents are not native types, do not modify them.

Returns T[]
- Defined in misc/BlockingPriorityQueue.ts:89

length

get length(): number
Get the number of elements in the queue.

Returns number
- Defined in misc/BlockingPriorityQueue.ts:72

pendingPromiseCount

get pendingPromiseCount(): number
Get the number of pending promises if no elements are in the queue.

Returns number
- Defined in misc/BlockingPriorityQueue.ts:79

Methods

add

add(data: T, priority?: number): void
Add data to the queue.

This will throw if the queue is full.
Parameters
- data: T
- priority: number = 0
  lower values will have higher priority
Returns void
- Defined in misc/BlockingPriorityQueue.ts:37

cancelPendingPromises

cancelPendingPromises(_err?: Error): void
Cancels all pending remove promises.
Parameters
- Optional_err: Error
Returns void
- Defined in misc/BlockingPriorityQueue.ts:58

clear

clear(): T[]
Clears the queue and returns the internal array.

Returns T[]
- Defined in misc/BlockingPriorityQueue.ts:65

remove

remove(timeout?: number): Promise<T>
Get element from queue.

If no element is in the queue, then the promise will not resolve, until there is.
Parameters
- Optionaltimeout: number
  Timeout as unsigned 32-bit integer or Number.POSITIVE_INFINITY. If undefined use the default value passed to the constructor.
Returns Promise<T>
- Defined in misc/BlockingPriorityQueue.ts:49

`Static`compareFn

compareFn(a: [number, unknown], b: [number, unknown]): number
Compare function for sorting priorities.
Parameters
- a: [number, unknown]
- b: [number, unknown]
Returns number
- Defined in misc/BlockingPriorityQueue.ts:99