StructMap

StructMap

Map-like data structure

Constructor

new StructMap() → {StructMap}

Source:
Returns:
  • StructMap struct
Type
StructMap

Members

(static) data :Struct

Source:

Key-value pairs

Type:
  • Struct

(static) size :Number

Source:

Amount of defined entries.

Type:
  • Number

Methods

(static) clear()

Source:

Remove all items from StructMap

(static) exists(key) → {Bool}

Source:

Return true if the specified key exists in StructMap

Parameters:
Name Type Description
key Any
Returns:
Type
Bool

(static) find(value, funcopt) → {Any}

Source:

Returns the first key associated with value. If no such key exists then the function will return undefined.

Parameters:
Name Type Attributes Description
value Any
func Method <optional>

function of two arguments to compare Map item with value

Returns:

key associated with value

Type
Any

(static) get(key) → {Any}

Source:

Returns value associated with the key. If no such key exists then the function will return undefined.

Parameters:
Name Type Description
key Any
Returns:
Type
Any

(static) is_empty() → {Bool}

Source:

Return false if StructMap has any items, true if it does not.

Returns:
Type
Bool

(static) items() → {IteratorDict}

Source:

Returns Iterator of key-value pairs

Returns:
Type
IteratorDict

(static) keys() → {Iterator}

Source:

Returns Iterator of keys

Returns:
Type
Iterator

(static) set(key, value) → {Bool}

Source:

Sets new value associated with key.

Parameters:
Name Type Description
key Any

If key exists, previous value would be overwritten.

value Any

If undefined, key is removed.

Returns:
Type
Bool

(static) remove(key)

Source:

Remove key from the StructMap

Parameters:
Name Type Description
key Any