Class Queue<T>

A FIFO queue implementation.

Type Parameters

T
The type of elements in the queue.

Hierarchy (View Summary)

LinkedListCollection<T>
- Queue

Implements

IQueue<T>

Index

Constructors

constructor

new Queue<T>(iterable?: Iterable<T, any, any>, capacity?: number): Queue<T>
Type Parameters
- T
Parameters
- Optionaliterable: Iterable<T, any, any>
- capacity: number = Infinity
Returns Queue<T>
Inherited from LinkedListCollection.constructor
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:8

Properties

`Readonly`capacity

capacity: number = Infinity

The maximum number of elements the collection can hold. If the collection is unbounded, this will be Infinity.

`Protected` `Readonly`data

data: LinkedList<T>

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<T>
Returns AsyncIterator<T>
Implementation of IQueue.[asyncIterator]
Inherited from LinkedListCollection.[asyncIterator]
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:18

[iterator]

"[iterator]"(): Iterator<T>
Returns Iterator<T>
Implementation of IQueue.[iterator]
Inherited from LinkedListCollection.[iterator]
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:15

clear

clear(): void
Removes all elements from the collection.

Returns void
Implementation of IQueue.clear
Inherited from LinkedListCollection.clear
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:22

concat

concat(...items: T[]): IterableIterator<T>
Concatenates the given items to the end of the collection and returns an iterator over the merged items.

This method does not mutate the original collection.
Parameters
- ...items: T[]
  The items to merge.
Returns IterableIterator<T>
An iterator of the merged items.
Implementation of IQueue.concat
Inherited from LinkedListCollection.concat
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:30

count

count(): number
Returns the number of elements in the collection.

Returns number
Implementation of IQueue.count
Inherited from LinkedListCollection.count
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:26

dequeue

dequeue(): T | undefined
Removes and returns the item at the front of the queue.

Returns T | undefined
The item at the front of the queue, or undefined if the queue is empty.
Implementation of IQueue.dequeue
- Defined in packages/misc-util/src/data/queue.ts:22

enqueue

enqueue(...items: T[]): void
Adds one or more items to the rear of the queue.

The items are added in the order they are provided. The last item in the argument list will be the last one to be dequeued.
Parameters
- ...items: T[]
  The items to add to the queue.
Returns void
Throws
If the operation would exceed the queue's capacity.
Implementation of IQueue.enqueue
- Defined in packages/misc-util/src/data/queue.ts:11

front

front(): T | undefined
Returns the item at the front of the queue without removing it.

Returns T | undefined
The item at the front of the queue, or undefined if the queue is empty.
Implementation of IQueue.front
- Defined in packages/misc-util/src/data/queue.ts:34

remove

remove(condition: Predicate<[T]>): IterableIterator<T>
Removes all the items matching the given predicate from the collection.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the items to remove.
Returns IterableIterator<T>
An iterable of the removed items.
Implementation of IQueue.remove
Inherited from LinkedListCollection.remove
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:38

removeFirst

removeFirst(condition: Predicate<[T]>): boolean
Removes the first occurrence of the item matching the given predicate from the collection.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the item to remove.
Returns boolean
true if the item was found and removed, false otherwise.
Implementation of IQueue.removeFirst
Inherited from LinkedListCollection.removeFirst
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:34

replace

replace(
condition: Predicate<[T]>,
newItem: Callable<[T], T>,
): IterableIterator<T>
Replaces all the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the items to replace.
- newItem: Callable<[T], T>
Returns IterableIterator<T>
An iterable of the replaced items.
Implementation of IQueue.replace
Inherited from LinkedListCollection.replace
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:46

replaceFirst

replaceFirst(condition: Predicate<[T]>, newItem: T): boolean
Replaces the first occurence of the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the item to replace.
- newItem: T
  The new item to insert.
Returns boolean
true if the item was found and replaced, false otherwise.
Implementation of IQueue.replaceFirst
Inherited from LinkedListCollection.replaceFirst
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:42

waitEnqueue

waitEnqueue(items: Iterable<T>, signal?: AbortSignal | null): Promise<void>
Same as enqueue, but waits for capacity if the operation would exceed it.
Parameters
- items: Iterable<T>
- Optionalsignal: AbortSignal | null
  Optional abort signal to cancel the operation.
Returns Promise<void>
See
IQueue.enqueue
Implementation of IQueue.waitEnqueue
- Defined in packages/misc-util/src/data/queue.ts:15

Class Queue<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Queue<T>

Properties

Readonlycapacity

Protected Readonlydata

Methods

[asyncIterator]

Returns AsyncIterator<T>

[iterator]

Returns Iterator<T>

clear

Returns void

concat

Parameters

Returns IterableIterator<T>

count

Returns number

dequeue

Returns T | undefined

enqueue

Parameters

Returns void

Throws

front

Returns T | undefined

remove

Parameters

Returns IterableIterator<T>

removeFirst

Parameters

Returns boolean

replace

Parameters

Returns IterableIterator<T>

replaceFirst

Parameters

Returns boolean

waitEnqueue

Parameters

Returns Promise<void>

See

Settings

On This Page

`Readonly`capacity

`Protected` `Readonly`data