⁘ collections

DictionaryList

go to → Members

new DictionaryList()

TODO

Members

read-onlycount :number

TODO

read-onlyinternalMap :map

TODO

read-onlyisEmpty :boolean

TODO

read-onlykeys :IterableIterator.<any>

TODO

Methods

Clear()

Clears all keys and values.

Contains(p_key, p_value) → {boolean}

Return whether or not the Dictionary contains the given key. If a value is specified, return whether or not the key has the given value registered.

Parameters:
Name Type Description
p_key *
p_value *

Count(p_key) → {number}

Return the value count for the given key.

Parameters:
Name Type Description
p_key *

Get(p_key, p_index) → {*}

Return the list associated with the given key. If index is specified (>= 0), return the value at the given index or undefined if out-of-bounds

Parameters:
Name Type Description
p_key *
p_index number

Pop(p_key) → {*}

Remove and return the last value from the list associated with the given key

Parameters:
Name Type Description
p_key *

Remove(p_key, p_value) → {boolean}

Remove the given value from the list associated with the given key. Returns true if the value existed and has been removed, otherwise return false.

Parameters:
Name Type Description
p_key *
p_value *

RemoveMultiple(p_key, …args)

TODO

Parameters:
Name Type Attributes Description
p_key *
args any <repeatable>

Set(p_key, p_value)

Add a value to the list associated with the given key.

Parameters:
Name Type Description
p_key *
p_value *