IMap
Defined in: packages/data/src/map/imap.ts:13
A key-to-value association.
count() (inherited from ICollection) is the number of entries, which
for a map is the same number as the number of keys — a map cannot hold two
entries for one key by definition, so no separate keyCount() is needed here
(unlike IMultimap, where it can differ).
Extends
Section titled “Extends”ICollection<readonly [K,V]>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”K
V extends DefinedValue
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
Iterator<readonly [K,V],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<readonly [K, V], 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”delete()
Section titled “delete()”delete(
key):boolean
Defined in: packages/data/src/map/imap.ts:19
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”boolean
entries()
Section titled “entries()”entries():
IterableIterator<readonly [K,V]>
Defined in: packages/data/src/map/imap.ts:22
Returns
Section titled “Returns”IterableIterator<readonly [K, V]>
get(
key):V|undefined
Defined in: packages/data/src/map/imap.ts:16
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”V | undefined
has(
key):boolean
Defined in: packages/data/src/map/imap.ts:18
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”boolean
keys()
Section titled “keys()”keys():
IterableIterator<K>
Defined in: packages/data/src/map/imap.ts:20
Returns
Section titled “Returns”IterableIterator<K>
set(
key,value):void
Defined in: packages/data/src/map/imap.ts:17
Parameters
Section titled “Parameters”K
V
Returns
Section titled “Returns”void
values()
Section titled “values()”values():
IterableIterator<V>
Defined in: packages/data/src/map/imap.ts:21
Returns
Section titled “Returns”IterableIterator<V>