Interface ReadonlyMultiMap<K, V>

A ReadonlyMultiMap can have multiple values per key.

Type Parameters

K

the key type
V

the value type

Hierarchy

Iterable<Entry<K, V>>
- ReadonlyMultiMap
  - MultiMap

Index

Properties

[toStringTag] size

Methods

[iterator] entries forEach get has keys values

Properties

[toStringTag]

[toStringTag]: string

`Readonly` size

size: number

Returns

the number of entries in this MultiMap

Methods

[iterator]

[iterator](): Iterator<Entry<K, V>, any, undefined>
Returns Iterator<Entry<K, V>, any, undefined>
Inherited from Iterable.__@iterator@3803
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:51

entries

entries(): IterableIterator<[K, V]>
See
Map.entries

Returns IterableIterator<[K, V]>
- Defined in packages/collections/src/_types.ts:54

forEach

forEach(callbackfn: ((value: V, key: K, multiMap: ReadonlyMultiMap<K, V>) => void)): void
See
Map.forEach
Parameters
- callbackfn: ((value: V, key: K, multiMap: ReadonlyMultiMap<K, V>) => void)
  - - (value: V, key: K, multiMap: ReadonlyMultiMap<K, V>): void
    - Parameters
      
      value: V
      
      key: K
      
      multiMap: ReadonlyMultiMap<K, V>
      
      Returns void
Returns void
- Defined in packages/collections/src/_types.ts:13

get

get(key: K): Iterable<V>
Gets all values for this key.

Returns an empty iterable if the key does not exist.

Returns
an Iterable containing all values for this key
Parameters
- key: K
  
  the key to look up
Returns Iterable<V>
- Defined in packages/collections/src/_types.ts:23

has

has(key: K): boolean
Checks if this MultiMap contains an entry for this key.

See
Map.has

Returns
true if an entry with the given key exists, otherwise false
Parameters
- key: K
  
  the key to look up
Returns boolean
- Defined in packages/collections/src/_types.ts:33
has(key: K, value: V): boolean
Checks if this MultiMap contains an entry with the key and value.

See
Map.has

Returns
true if an entry with the given key and value exists, otherwise false
Parameters
- key: K
  
  the key to look up
- value: V
  
  the value to look for
Returns boolean
- Defined in packages/collections/src/_types.ts:44

keys

keys(): IterableIterator<K>
See
Map.keys

Returns IterableIterator<K>
- Defined in packages/collections/src/_types.ts:59

values

values(): IterableIterator<V>
See
Map.forEach

Returns IterableIterator<V>
- Defined in packages/collections/src/_types.ts:64

Generated using TypeDoc