IWaitablePriorityQueue
Defined in: packages/data/src/priority-queue/iwaitable-priority-queue.ts:11
The blocking sibling of IBoundedPriorityQueue: waits for capacity
instead of throwing when the queue is full. The inherited insert still
throws — this adds a way to wait, it does not change the way to fail.
Extends
Section titled “Extends”IPriorityQueue<T,P>.IBounded
Type Parameters
Section titled “Type Parameters”T extends DefinedValue = DefinedValue
P = number
Properties
Section titled “Properties”capacity
Section titled “capacity”
readonlycapacity:number
Defined in: packages/data/src/collection/ibounded.ts:17
The maximum number of elements the collection can hold.
Note: Infinity is not a legal value here — an unbounded type omits this
mixin.
Inherited from
Section titled “Inherited from”precedes
Section titled “precedes”
readonlyprecedes:OrderPredicate<P>
Defined in: packages/data/src/priority-queue/ipriority-queue.ts:34
Strict weak ordering over priorities: precedes(a, b) means a outranks
b.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
Iterator<T,any,any>
Defined in: node_modules/.store/typescript-npm-6.0.3-585eecd158/package/lib/lib.es2015.iterable.d.ts:47
Returns
Section titled “Returns”Iterator<T, any, any>
Inherited from
Section titled “Inherited from”clear()
Section titled “clear()”clear():
void
Defined in: packages/data/src/collection/icollection.ts:23
Removes all elements from the collection.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”count()
Section titled “count()”count():
number
Defined in: packages/data/src/collection/icollection.ts:20
The number of elements in the collection.
A method, not a getter: its async counterpart needs a round trip to the backing store, and a member must have the same shape in both.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”entries()
Section titled “entries()”entries():
IterableIterator<PriorityEntry<T,P>>
Defined in: packages/data/src/priority-queue/ipriority-queue.ts:81
Every entry, in priority order (highest first).
Returns
Section titled “Returns”IterableIterator<PriorityEntry<T, P>>
Inherited from
Section titled “Inherited from”extract()
Section titled “extract()”extract():
T|undefined
Defined in: packages/data/src/priority-queue/ipriority-queue.ts:59
Removes and returns the item with the highest priority from the priority queue.
Returns
Section titled “Returns”T | undefined
The item with the highest priority, or undefined if the queue is
empty.
Inherited from
Section titled “Inherited from”insert()
Section titled “insert()”insert(
priority,item):void
Defined in: packages/data/src/priority-queue/ipriority-queue.ts:42
Inserts an item with its associated priority into the priority queue.
Parameters
Section titled “Parameters”priority
Section titled “priority”P
The priority of the item to insert.
T
The item to insert.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”insertAll()
Section titled “insertAll()”insertAll(
priority,items):void
Defined in: packages/data/src/priority-queue/ipriority-queue.ts:50
Inserts every item at the same priority into the priority queue.
Parameters
Section titled “Parameters”priority
Section titled “priority”P
The priority shared by all the items to insert.
readonly T[]
The items to insert.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”peek()
Section titled “peek()”peek():
T|undefined
Defined in: packages/data/src/priority-queue/ipriority-queue.ts:68
Returns the item with the highest priority without removing it from the queue.
Returns
Section titled “Returns”T | undefined
The item with the highest priority, or undefined if the queue is
empty.
Inherited from
Section titled “Inherited from”setPriority()
Section titled “setPriority()”setPriority(
item,priority):boolean
Defined in: packages/data/src/priority-queue/ipriority-queue.ts:78
Updates the priority of an existing item in the priority queue.
Parameters
Section titled “Parameters”T
The item whose priority is to be updated.
priority
Section titled “priority”P
The new priority of the item.
Returns
Section titled “Returns”boolean
true if the item was found and its priority updated, false
otherwise.
Inherited from
Section titled “Inherited from”waitInsert()
Section titled “waitInsert()”waitInsert(
priority,item,signal?):Promise<void>
Defined in: packages/data/src/priority-queue/iwaitable-priority-queue.ts:22
Same as insert, but waits for capacity if the operation would exceed it.
Parameters
Section titled “Parameters”priority
Section titled “priority”P
T
signal?
Section titled “signal?”AbortSignal | null
Optional abort signal to cancel the operation.
Returns
Section titled “Returns”Promise<void>
IPriorityQueue.insert
waitInsertAll()
Section titled “waitInsertAll()”waitInsertAll(
priority,items,signal?):Promise<void>
Defined in: packages/data/src/priority-queue/iwaitable-priority-queue.ts:32
Same as insertAll, but waits for capacity if the operation would exceed
it. The whole batch lands at once, never interleaved with another
waiter’s.
Parameters
Section titled “Parameters”priority
Section titled “priority”P
Iterable<T>
signal?
Section titled “signal?”AbortSignal | null
Optional abort signal to cancel the operation.
Returns
Section titled “Returns”Promise<void>
IPriorityQueue.insertAll