Class StringMap<ValueType>

A map of string keys to some ValueType.

Type Parameters

  • ValueType

Constructors

constructor

Properties

_map

Accessors

keys values size

Methods

get setKey setUndefinedKey

Constructors

constructor

Properties

Private Readonly _map

_map: Map<string, ValueType>

The underlying map object.

Accessors

keys

  • get keys(): IterableIterator<string>

  • Returns IterableIterator<string>

    All the keys of the map.

values

  • get values(): IterableIterator<ValueType>

  • Returns IterableIterator<ValueType>

    All the values of the map.

size

  • get size(): number

  • Returns number

    The size of the map.

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

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

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.

    • Optional errorMessage: string

      Message to log if the key already has a value.

    Returns boolean

    true if the operation is successful, false if it is not.

Settings

Member Visibility

Theme

On This Page

constructor _map keys values size get setKey setUndefinedKey