Interface MultiMap<K, V>

A MultiMap can have multiple values per key.

Type Parameters

K

the key type
V

the value type

Hierarchy

ReadonlyMultiMap<K, V>
- MultiMap

Implemented by

AbstractMultiMap

Index

Properties

[toStringTag] size

Methods

[iterator] add addAll clear delete entries forEach get has keys set 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 ReadonlyMultiMap.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:51

add

add(key: K, value: V): MultiMap<K, V>
Adds a value for a key to this MultiMap.

Returns
this MultiMap
Parameters
- key: K
  
  the key to look up
- value: V
  
  the value to add
Returns MultiMap<K, V>
- Defined in packages/collections/src/_types.ts:116

addAll

addAll(entries: Iterable<Entry<K, V>>): void
Adds all entries to this MultiMap.
Parameters
- entries: Iterable<Entry<K, V>>
  
  the entries to add
Returns void
- Defined in packages/collections/src/_types.ts:123

clear

clear(): void
Removes all entries.

Returns void
- Defined in packages/collections/src/_types.ts:79

delete

delete(key: K): boolean
Deletes the key with all its values.

Returns
true if an entry was deleted, otherwise false
Parameters
- key: K
  
  the key to delete
Returns boolean
- Defined in packages/collections/src/_types.ts:87
delete(key: K, value: V): boolean
Deletes the first entry with the given key and value.

Returns
true if an entry was deleted, otherwise false
Parameters
- key: K
  
  the key to look for
- value: V
  
  the value to delete
Returns boolean
- Defined in packages/collections/src/_types.ts:96

entries

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

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

forEach

forEach(callbackfn: ((value: V, key: K, multiMap: MultiMap<K, V>) => void)): void
See
Map.forEach
Parameters
- callbackfn: ((value: V, key: K, multiMap: MultiMap<K, V>) => void)
  - - (value: V, key: K, multiMap: MultiMap<K, V>): void
    - Parameters
      
      value: V
      
      key: K
      
      multiMap: MultiMap<K, V>
      
      Returns void
Returns void
Inherited from ReadonlyMultiMap.forEach
- 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>
Inherited from ReadonlyMultiMap.get
- 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
Inherited from ReadonlyMultiMap.has
- 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
Inherited from ReadonlyMultiMap.has
- Defined in packages/collections/src/_types.ts:44

keys

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

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

set

set(key: K, values: Iterable<V>): MultiMap<K, V>
Set the values for a key and replaces all previous values for this key.

If no values are provided all previous entries will be removed.

Returns
this MultiMap
Parameters
- key: K
  
  the key to set
- values: Iterable<V>
Returns MultiMap<K, V>
- Defined in packages/collections/src/_types.ts:107

values

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

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

Interface MultiMap<K, V>

Type Parameters

K

V

Hierarchy

Implemented by

Index

Properties

Methods

Properties

[toStringTag]

Readonly size

Returns

Methods

[iterator]

Returns Iterator<Entry<K, V>, any, undefined>

add

Returns

Parameters

key: K

value: V

Returns MultiMap<K, V>

addAll

Parameters

entries: Iterable<Entry<K, V>>

Returns void

clear

Returns void

delete

Returns

Parameters

key: K

Returns boolean

Returns

Parameters

key: K

value: V

Returns boolean

entries

See

Returns IterableIterator<[K, V]>

forEach

See

Parameters

callbackfn: ((value: V, key: K, multiMap: MultiMap<K, V>) => void)

Parameters

value: V

key: K

multiMap: MultiMap<K, V>

Returns void

Returns void

get

Returns

Parameters

key: K

Returns Iterable<V>

has

See

Returns

Parameters

key: K

Returns boolean

See

Returns

Parameters

key: K

value: V

Returns boolean

keys

See

Returns IterableIterator<K>

set

Returns

Parameters

key: K

values: Iterable<V>

Returns MultiMap<K, V>

values

See

Returns IterableIterator<V>

`Readonly` size