Class QueueImmutable<V>

Queue (immutable). See also QueueMutable.

Queues are useful if you want to treat 'older' or 'newer' items differently. Enqueing adds items at the back of the queue, while dequeing removes items from the front (ie. the oldest).

let q = queue();           // Create
q = q.enqueue(`a`, `b`);   // Add two strings
const front = q.peek;      // `a` is at the front of queue (oldest)
q = q.dequeue();           // q now just consists of `b`

Example: Cap size to 5 items, throwing away newest items already in queue.

const q = queue({capacity: 5, discardPolicy: `newer`});

Type Parameters

Implements

IQueueImmutable<V>

Index

Accessors

isEmpty

get isEmpty(): boolean
Returns true if queue is empty

Returns boolean
Implementation of IQueueImmutable.isEmpty
- Defined in packages/collections/src/queue/queue-immutable.ts:48

isFull

get isFull(): boolean
Is queue full? Returns false if no capacity has been set

Returns boolean
Implementation of IQueueImmutable.isFull
- Defined in packages/collections/src/queue/queue-immutable.ts:52

length

get length(): number
Number of items in queue

Returns number
Implementation of IQueueImmutable.length
- Defined in packages/collections/src/queue/queue-immutable.ts:56

peek

get peek(): undefined | V
Returns front of queue (oldest item), or undefined if queue is empty

Returns undefined | V
Implementation of IQueueImmutable.peek
- Defined in packages/collections/src/queue/queue-immutable.ts:60

Constructors

constructor

new QueueImmutable<V>(
opts?: QueueOpts<V>,
data?: readonly V[],
): QueueImmutable<V>
Creates an instance of Queue.
Type Parameters
- V
Parameters
- opts: QueueOpts<V> = {}
  Options foor queue
- data: readonly V[] = []
  Initial data. Index 0 is front of queue
Returns QueueImmutable<V>
- Defined in packages/collections/src/queue/queue-immutable.ts:17

Methods

dequeue

dequeue(): QueueImmutable<V>
Dequeues (removes oldest item / item at front of queue). Use peek to get item that will be removed.

Returns QueueImmutable<V>
Queue with item removed
Implementation of IQueueImmutable.dequeue
- Defined in packages/collections/src/queue/queue-immutable.ts:44

enqueue

enqueue(...toAdd: readonly V[] | V[]): QueueImmutable<V>
Returns a new queue with item(s) added
Parameters
- ...toAdd: readonly V[] | V[]
  Items to add
Returns QueueImmutable<V>
Implementation of IQueueImmutable.enqueue
- Defined in packages/collections/src/queue/queue-immutable.ts:37

forEach

forEach(fn: (v: V) => void): void
Enumerates queue from back-to-front
Parameters
- fn: (v: V) => void
Returns void
Implementation of IQueueImmutable.forEach
- Defined in packages/collections/src/queue/queue-immutable.ts:24

forEachFromFront

forEachFromFront(fn: (v: V) => void): void
Enumerates queue from front-to-back
Parameters
- fn: (v: V) => void
Returns void
Implementation of IQueueImmutable.forEachFromFront
- Defined in packages/collections/src/queue/queue-immutable.ts:31

toArray

toArray(): V[]
Returns a copy of data in queue as an array

Returns V[]
Implementation of IQueueImmutable.toArray
- Defined in packages/collections/src/queue/queue-immutable.ts:64

Properties

`Readonly`opts

opts: QueueOpts<V>

Class QueueImmutable<V>

Example: Cap size to 5 items, throwing away newest items already in queue.

Type Parameters

Implements

Index

Accessors

Constructors

Methods

Properties

Accessors

isEmpty

Returns boolean

isFull

Returns boolean

length

Returns number

peek

Returns undefined | V

Constructors

constructor

Type Parameters

Parameters

Returns QueueImmutable<V>

Methods

dequeue

Returns QueueImmutable<V>

enqueue

Parameters

Returns QueueImmutable<V>

forEach

Parameters

Returns void

forEachFromFront

Parameters

Returns void

toArray

Returns V[]

Properties

Readonlyopts

Settings

On This Page

`Readonly`opts