Class StringDictionary<T>
Type Parameters
T
Hierarchy
- StringDictionary
Index
Constructors
Accessors
Methods
Constructors
constructor
Type Parameters
T
Returns StringDictionary<T>
Accessors
count
Gets the current count
Returns number
Methods
addSearch playground for add
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
clearSearch playground for clear
Clear the whole content of the dictionary
Returns void
containsSearch playground for contains
Check if there's a given key in the dictionary
Parameters
key: string
the key to check for
Returns boolean
true if the key is present, false otherwise
copy
This will clear this dictionary and copy the content from the 'source' one. If the T value is a custom object, it won't be copied/cloned, the same object will be used
Parameters
source: StringDictionary<T>
the dictionary to take the content from and copy to this dictionary
Returns void
firstSearch playground for first
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
Parameters
key: string
val: T
Returns TRes
Returns null | NonNullable<TRes>
the first item
for
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
Parameters
key: string
val: T
Returns void
Returns void
getSearch playground for get
Get a value based from its key
Parameters
key: string
the given key to get the matching value from
Returns undefined | T
the value if found, otherwise undefined is returned
get
Get the element of the given key and remove it from the dictionary
Parameters
key: string
defines the key to search
Returns Nullable<T>
the value associated with the key or null if not found
get
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
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.
Parameters
key: string
Returns T
Returns T
the value corresponding to the key.
removeSearch playground for remove
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
setSearch playground for set
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)
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'