MwMap

Create an object that can be read from or written to via methods that allow interaction both with single and multiple properties at once.

Show:
Source:
Example
const map = new mw.Map();
  map.set( 'foo', 5 );
  5 === map.get( 'foo' ); // echo true

Methods

(static) exists(selection) → {boolean}

...

Check if a given key exists in the map.

Parameters:
Name Type Description
selection string

Key to check
Source:
Returns:

True if the key exists

Type
boolean

(static) get(selectionopt, fallbackopt) → {any|Object|null}

...

Get the value of one or more keys.

If called with no arguments, all values are returned.

Parameters:
Name Type Attributes Default Description
selection string | Array <optional>

Key or array of keys to retrieve values for.
fallback any <optional>
 null

Value for keys that don't exist.
Source:
Returns:

If selection was a string, returns the value, If selection was an array, returns an object of key/values. If no selection is passed, a new object with all key/values is returned.

Type
any | Object | null

(static) set(selection, valueopt) → {boolean}

...

Set one or more key/value pairs.

Parameters:
Name Type Attributes Description
selection string | Object

Key to set value for, or object mapping keys to values
value Mixed <optional>

Value to set (optional, only in use when key is a string)
Source:
Returns:

True on success, false on failure

Type
boolean