Class Deque<T>

A double-ended queue (deque) implementation.

Type Parameters

T
The type of elements in the deque.

Hierarchy (View Summary)

LinkedListCollection<T>
- Deque

Implements

IDeque<T>

Index

Constructors

constructor

new Deque<T>(iterable?: Iterable<T, any, any>, capacity?: number): Deque<T>
Type Parameters
- T
Parameters
- Optionaliterable: Iterable<T, any, any>
- capacity: number = Infinity
Returns Deque<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 IDeque.[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 IDeque.[iterator]
Inherited from LinkedListCollection.[iterator]
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:15

back

back(): T | undefined
Returns the item at the back of the deque without removing it.

Returns T | undefined
The item at the back of the deque, or undefined if the deque is empty.
Implementation of IDeque.back
- Defined in packages/misc-util/src/data/deque.ts:60

clear

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

Returns void
Implementation of IDeque.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 IDeque.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 IDeque.count
Inherited from LinkedListCollection.count
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:26

front

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

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

pop

pop(): T | undefined
Removes and returns the item at the back of the deque.

Returns T | undefined
The item at the back of the deque, or undefined if the deque is empty.
Implementation of IDeque.pop
- Defined in packages/misc-util/src/data/deque.ts:44

push

push(...items: T[]): void
Adds one or more items to the back of the deque.

The items are added in the order they are provided, with the last item in the argument list becoming the new back of the deque.
Parameters
- ...items: T[]
  The items to add to the back of the deque.
Returns void
Throws
If the operation would exceed the deque's capacity.
Implementation of IDeque.push
- Defined in packages/misc-util/src/data/deque.ts:22

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 IDeque.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 IDeque.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 IDeque.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 IDeque.replaceFirst
Inherited from LinkedListCollection.replaceFirst
- Defined in packages/misc-util/src/data/collection-base/linked-list-collection.ts:42

shift

shift(): T | undefined
Removes and returns the item at the front of the deque.

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

unshift

unshift(...items: T[]): void
Adds one or more items to the front of the deque.

The items are added in the order they are provided, with the last item in the argument list becoming the new front of the deque.
Parameters
- ...items: T[]
  The items to add to the front of the deque.
Returns void
Throws
If the operation would exceed the deque's capacity.
Implementation of IDeque.unshift
- Defined in packages/misc-util/src/data/deque.ts:11

waitPush

waitPush(items: Iterable<T>, signal?: AbortSignal | null): Promise<void>
Same as push, 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
IDeque.push
Implementation of IDeque.waitPush
- Defined in packages/misc-util/src/data/deque.ts:26

waitUnshift

waitUnshift(items: Iterable<T>, signal?: AbortSignal | null): Promise<void>
Same as unshift, 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
IDeque.unshift
Implementation of IDeque.waitUnshift
- Defined in packages/misc-util/src/data/deque.ts:15

Class Deque<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Deque<T>

Properties

Readonlycapacity

Protected Readonlydata

Methods

[asyncIterator]

Returns AsyncIterator<T>

[iterator]

Returns Iterator<T>

back

Returns T | undefined

clear

Returns void

concat

Parameters

Returns IterableIterator<T>

count

Returns number

front

Returns T | undefined

pop

Returns T | undefined

push

Parameters

Returns void

Throws

remove

Parameters

Returns IterableIterator<T>

removeFirst

Parameters

Returns boolean

replace

Parameters

Returns IterableIterator<T>

replaceFirst

Parameters

Returns boolean

shift

Returns T | undefined

unshift

Parameters

Returns void

Throws

waitPush

Parameters

Returns Promise<void>

See

waitUnshift

Parameters

Returns Promise<void>

See

Settings

On This Page

`Readonly`capacity

`Protected` `Readonly`data