Interface Queue<E>

A queue holds elements until they are read. The order in which elements are read is determined by the implementation of the queue.

interface Queue<E> {
    add(element: E): void;
    clear(): void;
    forEach(fn: (element: E) => unknown): void;
    isEmpty(): boolean;
    length(): number;
    peek(): undefined | E;
    read(): undefined | E;
}

Type Parameters

E

Implemented by

Index

Methods

add clear forEach isEmpty length peek read

Methods

add

add(element: E): void
Adds an element to the queue.
Parameters
- element: E
  the element to add
Returns void
- Defined in queue/queue.ts:10

clear

clear(): void
Clears the queue, removing all elements.

Returns void
- Defined in queue/queue.ts:15

forEach

forEach(fn: (element: E) => unknown): void
Calls the given function for each element in the queue.
Parameters
- fn: (element: E) => unknown
  the function to call
Returns void
- Defined in queue/queue.ts:21

isEmpty

isEmpty(): boolean
Whether the queue is empty.

Returns boolean
true if the queue is empty, false otherwise
- Defined in queue/queue.ts:33

length

length(): number
Number of elements in the queue.

Returns number
the number of elements in the queue
- Defined in queue/queue.ts:27

peek

peek(): undefined | E
Returns the next element in the queue without removing it.

Returns undefined | E
the next element in the queue, or undefined if the queue is empty
- Defined in queue/queue.ts:39

read

read(): undefined | E
Removes and returns the next element in the queue.

Returns undefined | E
the next element in the queue, or undefined if the queue is empty
- Defined in queue/queue.ts:45