IMultimap
Defined in: packages/data/src/multimap/imultimap.ts:12
A key-to-many-values association.
count() (inherited from ICollection) is the total number of (key, value) entries across every key — a key with three values contributes three
to count(), not one. keyCount() is the number of distinct keys, and
keys() yields each of them once (a “key set”, not a (key, value)
count-many repetition).
Extends
Section titled “Extends”ICollection<readonly [K,V]>
Type Parameters
Section titled “Type Parameters”K
V
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”add(
key,value):void
Defined in: packages/data/src/multimap/imultimap.ts:14
Parameters
Section titled “Parameters”K
V
Returns
Section titled “Returns”void
addAll()
Section titled “addAll()”addAll(
key,values):void
Defined in: packages/data/src/multimap/imultimap.ts:20
Takes an Iterable so another key’s values can be added without
materialising them.
Parameters
Section titled “Parameters”K
values
Section titled “values”Iterable<V>
Returns
Section titled “Returns”void
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”countFor()
Section titled “countFor()”countFor(
key):number
Defined in: packages/data/src/multimap/imultimap.ts:26
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”number
delete()
Section titled “delete()”delete(
key):number
Defined in: packages/data/src/multimap/imultimap.ts:24
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”number
deleteEntry()
Section titled “deleteEntry()”deleteEntry(
key,value):boolean
Defined in: packages/data/src/multimap/imultimap.ts:25
Parameters
Section titled “Parameters”K
V
Returns
Section titled “Returns”boolean
entries()
Section titled “entries()”entries():
IterableIterator<readonly [K,V]>
Defined in: packages/data/src/multimap/imultimap.ts:29
Returns
Section titled “Returns”IterableIterator<readonly [K, V]>
get(
key):IterableIterator<V>
Defined in: packages/data/src/multimap/imultimap.ts:13
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”IterableIterator<V>
has(
key):boolean
Defined in: packages/data/src/multimap/imultimap.ts:22
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”boolean
hasEntry()
Section titled “hasEntry()”hasEntry(
key,value):boolean
Defined in: packages/data/src/multimap/imultimap.ts:23
Parameters
Section titled “Parameters”K
V
Returns
Section titled “Returns”boolean
keyCount()
Section titled “keyCount()”keyCount():
number
Defined in: packages/data/src/multimap/imultimap.ts:27
Returns
Section titled “Returns”number
keys()
Section titled “keys()”keys():
IterableIterator<K>
Defined in: packages/data/src/multimap/imultimap.ts:28
Returns
Section titled “Returns”IterableIterator<K>