API
API|
@babylonjs/core|
StringDictionary

Class StringDictionary<T>

This class implement a typical dictionary using a string as key and the generic type T as value. The underlying implementation relies on an associative array to ensure the best performances. The value can be anything including 'null' but except 'undefined'

Type Parameters

  • T
Index
constructor
count
add clear contains copyFrom first forEach get getAndRemove getOrAdd getOrAddWithFactory remove set

  • Add a new key and its corresponding value

    Parameters

    • key: string

      the key to add

    • value: T

      the value corresponding to the key

    Returns boolean

    true if the operation completed successfully, false if we couldn't insert the key/value because there was already this key in the dictionary

  • Execute a callback on every occurrence of the dictionary until it returns a valid TRes object. If the callback returns null or undefined the method will iterate to the next key/value pair Note that you can remove any element in this dictionary in the callback implementation

    Type Parameters

    • TRes

    Parameters

    • callback: (key: string, val: T) => TRes

      the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned

    Returns NonNullable<TRes> | null

    the first item

  • Execute a callback on each key/val of the dictionary. Note that you can remove any element in this dictionary in the callback implementation

    Parameters

    • callback: (key: string, val: T) => void

      the callback to execute on a given key/value pair

    Returns void

  • Get a value based from its key

    Parameters

    • key: string

      the given key to get the matching value from

    Returns T | undefined

    the value if found, otherwise undefined is returned

  • Get a value from its key if present in the dictionary otherwise add it

    Parameters

    • key: string

      the key to get the value from

    • val: T

      if there's no such key/value pair in the dictionary add it with this value

    Returns T

    the value corresponding to the key

  • Get a value from its key or add it if it doesn't exist. This method will ensure you that a given key/data will be present in the dictionary.

    Parameters

    • key: string

      the given key to get the matching value from

    • factory: (key: string) => T

      the factory that will create the value if the key is not present in the dictionary. The factory will only be invoked if there's no data for the given key.

    Returns T

    the value corresponding to the key.

  • Remove a key/value from the dictionary.

    Parameters

    • key: string

      the key to remove

    Returns boolean

    true if the item was successfully deleted, false if no item with such key exist in the dictionary

  • Update a specific value associated to a key

    Parameters

    • key: string

      defines the key to use

    • value: T

      defines the value to store

    Returns boolean

    true if the value was updated (or false if the key was not found)