Interface IPriorityQueue<T, P>

Interface representing a priority queue data type.

A priority queue is a collection where each item has a priority associated with it. Items with higher priority are served before items with lower priority.

interface IPriorityQueue<T = unknown, P = number> {
    capacity: number;
    isHigherPriority: PriorityQueueIsHigherPriorityPredicate<P>;
    "[asyncIterator]"(): AsyncIterator<[T, P], any, any>;
    "[iterator]"(): Iterator<Promisable<[T, P]>, any, any>;
    clear(): Promisable<void>;
    concat(...items: [T, P][]): MaybeAsyncIterableIterator<[T, P]>;
    count(): Promisable<number>;
    extract(): Promisable<undefined | T>;
    insert(priority: P, ...items: T[]): Promisable<void>;
    peek(): Promisable<undefined | T>;
    remove(
        condition: Predicate<[[T, P]]>,
    ): Promisable<MaybeAsyncIterableIterator<[T, P]>>;
    removeFirst(condition: Predicate<[[T, P]]>): Promisable<boolean>;
    replace(
        condition: Predicate<[[T, P]]>,
        newItemFactory: Callable<[[T, P]], [T, P]>,
    ): Promisable<MaybeAsyncIterableIterator<[T, P]>>;
    replaceFirst(
        condition: Predicate<[[T, P]]>,
        newItem: [T, P],
    ): Promisable<boolean>;
    setPriority(item: T, newPriority: P): Promisable<boolean>;
    waitInsert(
        priority: P,
        items: Iterable<T>,
        signal?: null | AbortSignal,
    ): PromiseLike<void>;
}

Type Parameters

T = unknown
The type of elements in the priority queue.
P = number
The type of priority values.

Hierarchy (View Summary)

ICollection<[T, P]>
- IPriorityQueue

Implemented by

PriorityQueue

Index

Properties

capacity isHigherPriority

Methods

[asyncIterator] [iterator] clear concat count extract insert peek remove removeFirst replace replaceFirst setPriority waitInsert

Properties

`Readonly`capacity

capacity: number

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

`Readonly`isHigherPriority

isHigherPriority: PriorityQueueIsHigherPriorityPredicate<P>

Predicate function which determine if one priority is higher than another.

Methods

[asyncIterator]

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

[iterator]

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

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, P][]): MaybeAsyncIterableIterator<[T, P]>
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, P][]
  The items to merge.
Returns MaybeAsyncIterableIterator<[T, P]>
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

extract

extract(): Promisable<undefined | T>
Removes and returns the item with the highest priority from the priority queue.

Returns Promisable<undefined | T>
The item with the highest priority, or undefined if the queue is empty.
- Defined in packages/misc-util/src/data/abstract-types/ipriority-queue.ts:49

insert

insert(priority: P, ...items: T[]): Promisable<void>
Inserts one or more items with their associated priorities into the priority queue.
Parameters
- priority: P
  The priority of the items to insert.
- ...items: T[]
  The items to insert.
Returns Promisable<void>
Throws
If the operation would exceed the deque's capacity.
- Defined in packages/misc-util/src/data/abstract-types/ipriority-queue.ts:30

peek

peek(): Promisable<undefined | T>
Returns the item with the highest priority without removing it from the queue.

Returns Promisable<undefined | T>
The item with the highest priority, or undefined if the queue is empty.
- Defined in packages/misc-util/src/data/abstract-types/ipriority-queue.ts:56

remove

remove(
condition: Predicate<[[T, P]]>,
): Promisable<MaybeAsyncIterableIterator<[T, P]>>
Removes all the items matching the given predicate from the collection.
Parameters
- condition: Predicate<[[T, P]]>
  A predicate function to identify the items to remove.
Returns Promisable<MaybeAsyncIterableIterator<[T, P]>>
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, P]]>): Promisable<boolean>
Removes the first occurrence of the item matching the given predicate from the collection.
Parameters
- condition: Predicate<[[T, P]]>
  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, P]]>,
newItemFactory: Callable<[[T, P]], [T, P]>,
): Promisable<MaybeAsyncIterableIterator<[T, P]>>
Replaces all the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[[T, P]]>
  A predicate function to identify the items to replace.
- newItemFactory: Callable<[[T, P]], [T, P]>
  A function that takes the old item and returns the new item to insert.
Returns Promisable<MaybeAsyncIterableIterator<[T, P]>>
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, P]]>,
newItem: [T, P],
): Promisable<boolean>
Replaces the first occurence of the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[[T, P]]>
  A predicate function to identify the item to replace.
- newItem: [T, P]
  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

setPriority

setPriority(item: T, newPriority: P): Promisable<boolean>
Updates the priority of an existing item in the priority queue.
Parameters
- item: T
  The item whose priority is to be updated.
- newPriority: P
  The new priority of the item.
Returns Promisable<boolean>
- Defined in packages/misc-util/src/data/abstract-types/ipriority-queue.ts:64

waitInsert

waitInsert(
    priority: P,
    items: Iterable<T>,
    signal?: null | AbortSignal,
): PromiseLike<void>
Same as insert, but waits for capacity if the operation would exceed it.
Parameters
- priority: P
- items: Iterable<T>
- Optionalsignal: null | AbortSignal
  Optional abort signal to cancel the operation.
Returns PromiseLike<void>
See
IPriorityQueue.insert
- Defined in packages/misc-util/src/data/abstract-types/ipriority-queue.ts:38

Interface IPriorityQueue<T, P>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

Readonlycapacity

ReadonlyisHigherPriority

Methods

[asyncIterator]

Returns AsyncIterator<[T, P], any, any>

[iterator]

Returns Iterator<Promisable<[T, P]>, any, any>

clear

Returns Promisable<void>

concat

Parameters

Returns MaybeAsyncIterableIterator<[T, P]>

count

Returns Promisable<number>

extract

Returns Promisable<undefined | T>

insert

Parameters

Returns Promisable<void>

Throws

peek

Returns Promisable<undefined | T>

remove

Parameters

Returns Promisable<MaybeAsyncIterableIterator<[T, P]>>

removeFirst

Parameters

Returns Promisable<boolean>

replace

Parameters

Returns Promisable<MaybeAsyncIterableIterator<[T, P]>>

replaceFirst

Parameters

Returns Promisable<boolean>

setPriority

Parameters

Returns Promisable<boolean>

waitInsert

Parameters

Returns PromiseLike<void>

See

Settings

On This Page

`Readonly`capacity

`Readonly`isHigherPriority