Interface Queue<T>

A queue data structure.

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

Type Parameters

T

Hierarchy

Queue

Index

Methods

front? push shift

Methods

`Optional` 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>
- Defined in collections/src/queue.ts:6

push

push(item, options?): unknown
Adds an item to this Queue.
Parameters
- item: T
- Optional options: AbortOptions
Returns unknown
- 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>
- Defined in collections/src/queue.ts:12

Generated using TypeDoc