Interface Queue<E>

Type parameters

E

Hierarchy

Collection<E>
- Queue

Implemented by

SLLQueue

Index

Properties

Methods

Properties

Readonly count

count: number

A non-negative integer indicating the number of elements in the collection.

Readonly isEmpty

isEmpty: boolean

A boolean indicating whether the collection is empty.

Methods

[iterator]

[iterator](): Iterator<E, any, undefined>

Inherited from Collection.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:51
Returns Iterator<E, any, undefined>

clear

clear(): void

Inherited from Collection.clear
- Defined in packages/ds/src/types/Collection.ts:15
Empties the collection.

Returns void

dequeue

dequeue(): E

- Defined in packages/ds/src/types/Queue.ts:19
Removes an item from the queue.

throws
NoSuchElementError Thrown if the queue is empty.

Returns E
The dequeued item.

enqueue

enqueue(element: E): void

- Defined in packages/ds/src/types/Queue.ts:9
Pushes an item to the queue.

Parameters
- element: E
  
  The new element to enqueue.
Returns void

peek

peek(): E

- Defined in packages/ds/src/types/Queue.ts:30
Retrieves, but does not remove, the head of this queue i.e. then item that will be removed if dequeue() is called.

throws
NoSuchElementError Thrown if the queue is empty.

Returns E
The head element.

toArray

toArray(): E[]

Inherited from Collection.toArray
- Defined in packages/ds/src/types/Collection.ts:22
Converts the collection into a plain array.

Returns E[]
A new array containing the items in this collection.

Generated using TypeDoc