Interface IDeque<T>

Interface representing a double-ended queue (deque) data type.

A deque is a generalized version of a queue that allows insertion and removal of items from both ends.

interface IDeque<T = unknown> {
    capacity: number;
    "[asyncIterator]"(): AsyncIterator<T, any, any>;
    "[iterator]"(): Iterator<Promisable<T>, any, any>;
    back(): Promisable<T | undefined>;
    clear(): Promisable<void>;
    concat(...items: T[]): MaybeAsyncIterableIterator<T>;
    count(): Promisable<number>;
    front(): Promisable<T | undefined>;
    pop(): Promisable<T | undefined>;
    push(...items: T[]): Promisable<void>;
    remove(
        condition: Predicate<[T]>,
    ): Promisable<MaybeAsyncIterableIterator<T>>;
    removeFirst(condition: Predicate<[T]>): Promisable<boolean>;
    replace(
        condition: Predicate<[T]>,
        newItemFactory: Callable<[T], T>,
    ): Promisable<MaybeAsyncIterableIterator<T>>;
    replaceFirst(condition: Predicate<[T]>, newItem: T): Promisable<boolean>;
    shift(): Promisable<T | undefined>;
    unshift(...items: T[]): Promisable<void>;
    waitPush(
        items: Iterable<T>,
        signal?: AbortSignal | null,
    ): PromiseLike<void>;
    waitUnshift(
        items: Iterable<T>,
        signal?: AbortSignal | null,
    ): PromiseLike<void>;
}

Type Parameters

T = unknown
The type of elements in the deque.

Hierarchy (View Summary)

ICollection<T>
- IDeque

Implemented by

Deque

Index

Properties

capacity

Methods

[asyncIterator] [iterator] back clear concat count front pop push remove removeFirst replace replaceFirst shift unshift waitPush waitUnshift

Properties

`Readonly`capacity

capacity: number

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

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<T, any, any>
Returns AsyncIterator<T, any, any>
Inherited from ICollection.[asyncIterator]
- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:38

[iterator]

"[iterator]"(): Iterator<Promisable<T>, any, any>
Returns Iterator<Promisable<T>, any, any>
Inherited from ICollection.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:49

back

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

Returns Promisable<T | undefined>
The item at the back of the deque, or undefined if the deque is empty.
- Defined in packages/misc-util/src/data/abstract-types/ideque.ts:80

clear

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

Returns Promisable<void>
Inherited from ICollection.clear
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:32

concat

concat(...items: T[]): MaybeAsyncIterableIterator<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 MaybeAsyncIterableIterator<T>
An iterator of the merged items.
Inherited from ICollection.concat
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:48

count

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

Returns Promisable<number>
Inherited from ICollection.count
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:37

front

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

Returns Promisable<T | undefined>
The item at the front of the deque, or undefined if the deque is empty.
- Defined in packages/misc-util/src/data/abstract-types/ideque.ts:73

pop

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

Returns Promisable<T | undefined>
The item at the back of the deque, or undefined if the deque is empty.
- Defined in packages/misc-util/src/data/abstract-types/ideque.ts:66

push

push(...items: T[]): Promisable<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 Promisable<void>
Throws
If the operation would exceed the deque's capacity.
- Defined in packages/misc-util/src/data/abstract-types/ideque.ts:44

remove

remove(condition: Predicate<[T]>): Promisable<MaybeAsyncIterableIterator<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 Promisable<MaybeAsyncIterableIterator<T>>
An iterable of the removed items.
Inherited from ICollection.remove
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:64

removeFirst

removeFirst(condition: Predicate<[T]>): Promisable<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 Promisable<boolean>
true if the item was found and removed, false otherwise.
Inherited from ICollection.removeFirst
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:56

replace

replace(
condition: Predicate<[T]>,
newItemFactory: Callable<[T], T>,
): Promisable<MaybeAsyncIterableIterator<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.
- newItemFactory: Callable<[T], T>
  A function that takes the old item and returns the new item to insert.
Returns Promisable<MaybeAsyncIterableIterator<T>>
An iterable of the replaced items.
Inherited from ICollection.replace
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:82

replaceFirst

replaceFirst(condition: Predicate<[T]>, newItem: T): Promisable<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 Promisable<boolean>
true if the item was found and replaced, false otherwise.
Inherited from ICollection.replaceFirst
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:73

shift

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

Returns Promisable<T | undefined>
The item at the front of the deque, or undefined if the deque is empty.
- Defined in packages/misc-util/src/data/abstract-types/ideque.ts:59

unshift

unshift(...items: T[]): Promisable<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 Promisable<void>
Throws
If the operation would exceed the deque's capacity.
- Defined in packages/misc-util/src/data/abstract-types/ideque.ts:22

waitPush

waitPush(items: Iterable<T>, signal?: AbortSignal | null): PromiseLike<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 PromiseLike<void>
See
IDeque.push
- Defined in packages/misc-util/src/data/abstract-types/ideque.ts:52

waitUnshift

waitUnshift(items: Iterable<T>, signal?: AbortSignal | null): PromiseLike<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 PromiseLike<void>
See
IDeque.unshift
- Defined in packages/misc-util/src/data/abstract-types/ideque.ts:30

Interface IDeque<T>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

Readonlycapacity

Methods

[asyncIterator]

Returns AsyncIterator<T, any, any>

[iterator]

Returns Iterator<Promisable<T>, any, any>

back

Returns Promisable<T | undefined>

clear

Returns Promisable<void>

concat

Parameters

Returns MaybeAsyncIterableIterator<T>

count

Returns Promisable<number>

front

Returns Promisable<T | undefined>

pop

Returns Promisable<T | undefined>

push

Parameters

Returns Promisable<void>

Throws

remove

Parameters

Returns Promisable<MaybeAsyncIterableIterator<T>>

removeFirst

Parameters

Returns Promisable<boolean>

replace

Parameters

Returns Promisable<MaybeAsyncIterableIterator<T>>

replaceFirst

Parameters

Returns Promisable<boolean>

shift

Returns Promisable<T | undefined>

unshift

Parameters

Returns Promisable<void>

Throws

waitPush

Parameters

Returns PromiseLike<void>

See

waitUnshift

Parameters

Returns PromiseLike<void>

See

Settings

On This Page

`Readonly`capacity