Class Queue<T>

A simple queue implementation.

Type Parameters

T

Index

Constructors

Accessors

Methods

[iterator] clear drain peek push shift

Constructors

constructor

new Queue<T>(initialValues?: T[]): Queue<T>
Creates a new queue.
Type Parameters
- T
Parameters
- OptionalinitialValues: T[]
  Optional initial values to add to the queue.
Returns Queue<T>
- Defined in Queue.ts:21

Accessors

length

get length(): number
Returns the length of the queue.

Returns number
The length of the queue.
- Defined in Queue.ts:90

Methods

[iterator]

"[iterator]"(): Generator<T>
Returns an iterator for the queue, without removing elements.

Returns Generator<T>
- Defined in Queue.ts:97

clear

clear(): void
Clears the queue.

Returns void
- Defined in Queue.ts:80

drain

drain(): Generator<T>
Drains the queue, returning all values and emptying the queue.

Returns Generator<T>
- Defined in Queue.ts:109

peek

peek(): undefined | T
Returns the value at the start of the queue without removing it.

Returns undefined | T
The value at the start of the queue or undefined if the queue is empty.
- Defined in Queue.ts:69

push

push(value: T): void
Adds a value to the end of the queue.
Parameters
- value: T
  The value to push.
Returns void
- Defined in Queue.ts:34

shift

shift(): undefined | T
Removes a value from the start of the queue.

Returns undefined | T
The removed value or undefined if the queue is empty.
- Defined in Queue.ts:52