IAsyncPriorityQueue
Defined in: packages/data/src/priority-queue/iasync-priority-queue.ts:14
The async-backed sibling of IPriorityQueue. No
IAsyncBlockingPriorityQueue: every async-backed method already returns a
Promise, so the sync world’s “throw vs. await” split collapses to one
Promise<void> shape — a separate blocking sibling would be a redundant,
identical type. precedes stays synchronous: a pure ordering function over
values the caller already holds, not I/O.
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”T extends DefinedValue = DefinedValue
P = number
Properties
Section titled “Properties”precedes
Section titled “precedes”
readonlyprecedes:OrderPredicate<P>
Defined in: packages/data/src/priority-queue/iasync-priority-queue.ts:18
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator]():
AsyncIterator<T,any,any>
Defined in: node_modules/.store/typescript-npm-6.0.3-585eecd158/package/lib/lib.es2018.asynciterable.d.ts:36
Returns
Section titled “Returns”AsyncIterator<T, any, any>
Inherited from
Section titled “Inherited from”IAsyncCollection.[asyncIterator]
clear()
Section titled “clear()”clear(
signal?):Promise<void>
Defined in: packages/data/src/collection/iasync-collection.ts:16
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”count()
Section titled “count()”count(
signal?):Promise<number>
Defined in: packages/data/src/collection/iasync-collection.ts:14
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<number>
Inherited from
Section titled “Inherited from”entries()
Section titled “entries()”entries(
signal?):AsyncIterableIterator<PriorityEntry<T,P>>
Defined in: packages/data/src/priority-queue/iasync-priority-queue.ts:34
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”AsyncIterableIterator<PriorityEntry<T, P>>
extract()
Section titled “extract()”extract(
signal?):Promise<T|undefined>
Defined in: packages/data/src/priority-queue/iasync-priority-queue.ts:28
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<T | undefined>
insert()
Section titled “insert()”insert(
priority,item,signal?):Promise<void>
Defined in: packages/data/src/priority-queue/iasync-priority-queue.ts:20
Parameters
Section titled “Parameters”priority
Section titled “priority”P
T
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
insertAll()
Section titled “insertAll()”insertAll(
priority,items,signal?):Promise<void>
Defined in: packages/data/src/priority-queue/iasync-priority-queue.ts:22
Parameters
Section titled “Parameters”priority
Section titled “priority”P
Iterable<T>
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
peek()
Section titled “peek()”peek(
signal?):Promise<T|undefined>
Defined in: packages/data/src/priority-queue/iasync-priority-queue.ts:30
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<T | undefined>
setPriority()
Section titled “setPriority()”setPriority(
item,priority,signal?):Promise<boolean>
Defined in: packages/data/src/priority-queue/iasync-priority-queue.ts:32
Parameters
Section titled “Parameters”T
priority
Section titled “priority”P
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<boolean>