Interface PeekableQueue<T>

A Queue that supports peeking the front element.

interface PeekableQueue {
    front(options?): MaybePromise<undefined | T>;
    push(item, options?): unknown;
    shift(options?): MaybePromise<undefined | T>;
}

Type Parameters

T

Hierarchy

Queue<T>
- PeekableQueue

Implemented by

BinaryHeap

Index

Methods

front push shift

Methods

front

front(options?): MaybePromise<undefined | T>
Returns the first item of this Queue, or undefined if empty.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<undefined | T>
Overrides Queue.front
- Defined in collections/src/queue.ts:17

push

push(item, options?): unknown
Adds an item to this Queue.
Parameters
- item: T
- Optional options: AbortOptions
Returns unknown
Inherited from Queue.push
- Defined in collections/src/queue.ts:9

shift

shift(options?): MaybePromise<undefined | T>
Removes and returns the first item of this Queue, or undefined if empty.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<undefined | T>
Inherited from Queue.shift
- Defined in collections/src/queue.ts:12

Generated using TypeDoc