IAsyncLossyHeap
Defined in: packages/data/src/heap/iasync-lossy-heap.ts:7
The async-backed sibling of ILossyHeap.
Extends
Section titled “Extends”Omit<IAsyncHeap<T>,"insert"|"insertAll">.ILossy
Type Parameters
Section titled “Type Parameters”T extends DefinedValue = DefinedValue
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<T>
Defined in: packages/data/src/heap/iasync-heap.ts:15
Inherited from
Section titled “Inherited from”Omit.precedes
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”Omit.[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”Omit.clear
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”Omit.count
extract()
Section titled “extract()”extract(
signal?):Promise<T|undefined>
Defined in: packages/data/src/heap/iasync-heap.ts:21
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<T | undefined>
Inherited from
Section titled “Inherited from”Omit.extract
extractAndInsert()
Section titled “extractAndInsert()”extractAndInsert(
item,signal?):Promise<T|undefined>
Defined in: packages/data/src/heap/iasync-heap.ts:25
Parameters
Section titled “Parameters”T
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<T | undefined>
Inherited from
Section titled “Inherited from”Omit.extractAndInsert
insert()
Section titled “insert()”insert(
item,signal?):Promise<readonlyT[]>
Defined in: packages/data/src/heap/iasync-lossy-heap.ts:9
Parameters
Section titled “Parameters”T
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<readonly T[]>
insertAll()
Section titled “insertAll()”insertAll(
items,signal?):Promise<readonlyT[]>
Defined in: packages/data/src/heap/iasync-lossy-heap.ts:11
Parameters
Section titled “Parameters”Iterable<T>
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<readonly T[]>
insertAndExtract()
Section titled “insertAndExtract()”insertAndExtract(
item,signal?):Promise<T|undefined>
Defined in: packages/data/src/heap/iasync-heap.ts:27
Parameters
Section titled “Parameters”T
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<T | undefined>
Inherited from
Section titled “Inherited from”Omit.insertAndExtract
peek()
Section titled “peek()”peek(
signal?):Promise<T|undefined>
Defined in: packages/data/src/heap/iasync-heap.ts:23
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<T | undefined>
Inherited from
Section titled “Inherited from”Omit.peek