IAsyncReplacingMap
Defined in: packages/data/src/map/iasync-replacing-map.ts:7
The async-backed sibling of IReplacingMap.
Extends
Section titled “Extends”Omit<IAsyncMap<K,V>,"set">.IReplacing
Type Parameters
Section titled “Type Parameters”K
V extends 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:ReplacementPolicy
Defined in: packages/data/src/collection/ireplacing.ts:25
The policy that determines which entry to replace when the collection exceeds its capacity.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator]():
AsyncIterator<readonly [K,V],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<readonly [K, V], 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
delete()
Section titled “delete()”delete(
key,signal?):Promise<boolean>
Defined in: packages/data/src/map/iasync-map.ts:12
Parameters
Section titled “Parameters”K
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”Omit.delete
entries()
Section titled “entries()”entries(
signal?):AsyncIterableIterator<readonly [K,V]>
Defined in: packages/data/src/map/iasync-map.ts:15
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”AsyncIterableIterator<readonly [K, V]>
Inherited from
Section titled “Inherited from”Omit.entries
get(
key,signal?):Promise<V|undefined>
Defined in: packages/data/src/map/iasync-map.ts:9
Parameters
Section titled “Parameters”K
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<V | undefined>
Inherited from
Section titled “Inherited from”Omit.get
has(
key,signal?):Promise<boolean>
Defined in: packages/data/src/map/iasync-map.ts:11
Parameters
Section titled “Parameters”K
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”Omit.has
keys()
Section titled “keys()”keys(
signal?):AsyncIterableIterator<K>
Defined in: packages/data/src/map/iasync-map.ts:13
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”AsyncIterableIterator<K>
Inherited from
Section titled “Inherited from”Omit.keys
set(
key,value,signal?):Promise<readonly readonly [K,V][]>
Defined in: packages/data/src/map/iasync-replacing-map.ts:9
Parameters
Section titled “Parameters”K
V
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<readonly readonly [K, V][]>
values()
Section titled “values()”values(
signal?):AsyncIterableIterator<V>
Defined in: packages/data/src/map/iasync-map.ts:14
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”AsyncIterableIterator<V>
Inherited from
Section titled “Inherited from”Omit.values