Class ArrayMultiMap<K, V>

An ArrayMultiMap can contain the same value multiple times per key.

Type Parameters

K

the key type
V

the value type

Hierarchy

AbstractMultiMap<K, V>
- ArrayMultiMap

Index

Constructors

constructor

new ArrayMultiMap<K, V>(iterable?: Iterable<Entry<K, V>>): ArrayMultiMap<K, V>
Create a new ArrayMultiMap from the given entries.
Type Parameters
- K
- V
Parameters
- Optional iterable: Iterable<Entry<K, V>>
  
  the optional Iterable of entries
Returns ArrayMultiMap<K, V>
Overrides AbstractMultiMap.constructor
- Defined in packages/collections/src/arrayMultiMap.ts:20

Properties

`Private` #value

#value: Map<K, V[]>

`Private` #value

#value: Map<K, Iterable<V>>

[toStringTag]

[toStringTag]: string = "MultiMap"

Accessors

size

get size(): number
Returns
the number of entries in this MultiMap

Returns number
Inherited from AbstractMultiMap.size
- Defined in packages/collections/src/abstractMultiMap.ts:59

Methods

[iterator]

[iterator](): IterableIterator<[K, V]>
Returns IterableIterator<[K, V]>
Inherited from AbstractMultiMap.[iterator]
- Defined in packages/collections/src/abstractMultiMap.ts:77

add

add(key: K, value: V): ArrayMultiMap<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 ArrayMultiMap<K, V>
Overrides AbstractMultiMap.add
- Defined in packages/collections/src/arrayMultiMap.ts:30

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
Inherited from AbstractMultiMap.addAll
- Defined in packages/collections/src/abstractMultiMap.ts:53

clear

clear(): void
Removes all entries.

Returns void
Inherited from AbstractMultiMap.clear
- Defined in packages/collections/src/abstractMultiMap.ts:24

delete

delete(key: K, value?: V): boolean
Deletes the key with all its values.

Returns
true if an entry was deleted, otherwise false
Parameters
- key: K
  
  the key to delete
- Optional value: V
Returns boolean
Overrides AbstractMultiMap.delete
- Defined in packages/collections/src/arrayMultiMap.ts:45

entries

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

Returns IterableIterator<[K, V]>
Inherited from AbstractMultiMap.entries
- Defined in packages/collections/src/abstractMultiMap.ts:63

forEach

forEach(callbackfn: ((value: V, key: K, multiMap: ArrayMultiMap<K, V>) => void)): void
See
Map.forEach
Parameters
- callbackfn: ((value: V, key: K, multiMap: ArrayMultiMap<K, V>) => void)
  - - (value: V, key: K, multiMap: ArrayMultiMap<K, V>): void
    - Parameters
      
      value: V
      
      key: K
      
      multiMap: ArrayMultiMap<K, V>
      
      Returns void
Returns void
Inherited from AbstractMultiMap.forEach
- Defined in packages/collections/src/abstractMultiMap.ts:32

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 AbstractMultiMap.get
- Defined in packages/collections/src/abstractMultiMap.ts:38

has

has(key: K, value?: V): 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
- Optional value: V
Returns boolean
Inherited from AbstractMultiMap.has
- Defined in packages/collections/src/abstractMultiMap.ts:42

keys

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

Returns IterableIterator<K>
Inherited from AbstractMultiMap.keys
- Defined in packages/collections/src/abstractMultiMap.ts:69

set

set(key: K, values: Iterable<V>): ArrayMultiMap<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 ArrayMultiMap<K, V>
Overrides AbstractMultiMap.set
- Defined in packages/collections/src/arrayMultiMap.ts:35

values

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

Returns IterableIterator<V>
Inherited from AbstractMultiMap.values
- Defined in packages/collections/src/abstractMultiMap.ts:73

Class ArrayMultiMap<K, V>

Type Parameters

K

V

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

K

V

Parameters

Optional iterable: Iterable<Entry<K, V>>

Returns ArrayMultiMap<K, V>

Properties

Private #value

Private #value

[toStringTag]

Accessors

size

Returns

Returns number

Methods

[iterator]

Returns IterableIterator<[K, V]>

add

Returns

Parameters

key: K

value: V

Returns ArrayMultiMap<K, V>

addAll

Parameters

entries: Iterable<Entry<K, V>>

Returns void

clear

Returns void

delete

Returns

Parameters

key: K

Optional value: V

Returns boolean

entries

See

Returns IterableIterator<[K, V]>

forEach

See

Parameters

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

Parameters

value: V

key: K

multiMap: ArrayMultiMap<K, V>

Returns void

Returns void

get

Returns

Parameters

key: K

Returns Iterable<V>

has

See

Returns

Parameters

key: K

Optional value: V

Returns boolean

keys

See

Returns IterableIterator<K>

set

Returns

Parameters

key: K

values: Iterable<V>

`Optional` iterable: Iterable<Entry<K, V>>

`Private` #value

`Private` #value

`Optional` value: V

`Optional` value: V