ILossyPriorityQueue
Defined in: packages/data/src/priority-queue/ilossy-priority-queue.ts:15
The lossy sibling of IPriorityQueue: never throws or waits when a
bounded priority queue is full, evicting or skipping instead
(overflowPolicy).
"evict" drops the root — the same element extract/peek already expose.
To keep the N highest-priority items instead, construct with the inverse
ordering.
Extends
Section titled “Extends”IPriorityQueue<T,P>.ILossy
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”overflowPolicy
Section titled “overflowPolicy”
readonlyoverflowPolicy:OverflowPolicy
Defined in: packages/data/src/collection/ilossy.ts:20
Policy applied when the collection reaches its capacity.
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): readonlyT[]
Defined in: packages/data/src/priority-queue/ilossy-priority-queue.ts:26
Same as IPriorityQueue.insert, but never throws — returns the items
dropped to make room (empty if nothing was dropped).
Parameters
Section titled “Parameters”priority
Section titled “priority”P
T
Returns
Section titled “Returns”readonly T[]
IPriorityQueue.insert
Overrides
Section titled “Overrides”insertAll()
Section titled “insertAll()”insertAll(
priority,items): readonlyT[]
Defined in: packages/data/src/priority-queue/ilossy-priority-queue.ts:34
Same as IPriorityQueue.insertAll, but never throws — returns the items
dropped to make room (empty if nothing was dropped).
Parameters
Section titled “Parameters”priority
Section titled “priority”P
readonly T[]
Returns
Section titled “Returns”readonly T[]
IPriorityQueue.insertAll
Overrides
Section titled “Overrides”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.