Class DefaultMap<K, V>

A default map allows for a generator producing values automatically if you want to add something to a map that does not have a value associated with a given key. This does not implement the default map interface as return types (and some future methods may) change

Type Parameters

K
V = K

Index

Constructors

Methods

delete entries get keys set size values

Constructors

constructor

new DefaultMap<K, V>(generator, map?): DefaultMap<K, V>
Type Parameters
- K
- V = K
Parameters
- generator: ((k: K) => V)
  the generator to produce a default value for a given key
  - - (k): V
    - Parameters
      k: K
      Returns V
- map: Map<K, V> = ...
  the initial map to start with
Returns DefaultMap<K, V>
- Defined in src/util/defaultmap.ts:15

Methods

delete

delete(k): boolean
Parameters
- k: K
Returns boolean
- Defined in src/util/defaultmap.ts:60

entries

entries(): IterableIterator<[K, V], any, any>
Iterates over all entries that have been set (explicitly or by the generator)

Returns IterableIterator<[K, V], any, any>
- Defined in src/util/defaultmap.ts:47

get

get(k): V
Return a value for the given key, if the key does not exist within the default map, this will invoke the generator and assign the produced value.
Parameters
- k: K
Returns V
- Defined in src/util/defaultmap.ts:33

keys

keys(): IterableIterator<K, any, any>
returns only the keys really stored in the map

Returns IterableIterator<K, any, any>
- Defined in src/util/defaultmap.ts:52

set

set(k, v): this
Sets a value for a given key. As you provide value, this does not invoke the generator!
Parameters
- k: K
- v: V
Returns this
- Defined in src/util/defaultmap.ts:24

size

size(): number
Returns number
- Defined in src/util/defaultmap.ts:64

values

values(): IterableIterator<V, any, any>
Returns IterableIterator<V, any, any>
- Defined in src/util/defaultmap.ts:56