Class StringMap<ValueType>

A map of string keys to some ValueType.

Type Parameters

ValueType

Index

Constructors

Accessors

keys size values

Methods

get hasKey setKey setUndefinedKey

Constructors

constructor

new StringMap<ValueType>(): StringMap<ValueType>
Type Parameters
- ValueType
Returns StringMap<ValueType>
- Defined in map/string-map.ts:28

Accessors

keys

get keys(): IterableIterator<string, any, any>
Returns IterableIterator<string, any, any>
All the keys of the map.
- Defined in map/string-map.ts:35

size

get size(): number
Returns number
The size of the map.
- Defined in map/string-map.ts:49

values

get values(): IterableIterator<ValueType, any, any>
Returns IterableIterator<ValueType, any, any>
All the values of the map.
- Defined in map/string-map.ts:42

Methods

get

get(key): undefined | ValueType
Retrieve the value associated with the given key.
Parameters
- key: string
  The key of the desired value in the map.
Returns undefined | ValueType
- Defined in map/string-map.ts:58

hasKey

hasKey(key): boolean
Returns true if the map contains the given key, returns false if it does not.
Parameters
- key: string
Returns boolean
- Defined in map/string-map.ts:67

setKey

setKey(key, value): void
Associate the given key with the given value in the map.
Parameters
- key: string
  Key to set in the map.
- value: ValueType
  Value to be associated with the key.
Returns void
- Defined in map/string-map.ts:77

setUndefinedKey

setUndefinedKey(key, value, errorMessage?): boolean
Associate the given key with the given value in the map only if the key has not been set in the map.
Parameters
- key: string
  Key to set in the map.
- value: ValueType
  Value to be associated with the key.
- OptionalerrorMessage: string
  Message to log if the key already has a value.
Returns boolean
true if the operation is successful, false if it is not.
- Defined in map/string-map.ts:90