///

Map Class

Map is a mutable key/value object for scripts that need lightweight map storage. It replaces the standard Map and converts every key to a string; otherwise standard Map code works as written.

Map.create()

Create a new map object.

let inventory = Map.create(); inventory.put('coins', 250); console.log(inventory.get('coins'));

Map.new Map()

Create a new map object.

let map = Map.create(); let result = Map.new Map(); console.log(result);

new Map([[key, value], ...])

Create a map pre-filled from pairs.

let result = new Map('demo', 'demo', 'demo'); console.log(result);

map.put(key, value)

Store a value. set returns the map, so calls chain.

map.put('mode', 'safe'); console.log(map.get('mode'));

map.set(key, value)

Store a value. set returns the map, so calls chain.

let map = Map.create(); map.set('retryCount', 1);

map.get(key)

Read a value.

map.put('mode', 'safe'); console.log(map.get('mode'));

map.has(key)

Check existence.

map.put('mode', 'safe'); console.log(map.has('mode'));

map.remove(key)

Delete one key. delete returns whether it was there.

map.put('mode', 'safe'); map.remove('mode'); console.log(map.has('mode'));

map.delete(key)

Delete one key. delete returns whether it was there.

let map = Map.create(); map.delete('retryCount');

map.clear()

Delete all entries.

map.put('mode', 'safe'); map.put('runs', 2); map.clear(); console.log(map.getSize());

map.keys()

Read keys, values, or [key, value] pairs, as arrays.

map.put('mode', 'safe'); map.put('runs', 2); console.log(map.keys());

map.values()

Read keys, values, or [key, value] pairs, as arrays.

map.put('mode', 'safe'); map.put('runs', 2); console.log(map.values());

map.entries()

Read keys, values, or [key, value] pairs, as arrays.

let map = Map.create(); let result = map.entries(); console.log(result);

map.getSize()

Number of entries.

map.put('mode', 'safe'); map.put('runs', 2); console.log(map.getSize());

map.size

Number of entries.

let map = Map.create(); let result = map.size; console.log(result);

map.isMapEmpty()

Whether the map is empty.

console.log(map.isMapEmpty());

map.forEach(fn)

Visit every entry as (value, key, map).

let map = Map.create(); let result = map.forEach('demo'); console.log(result);

for (const [key, value] of map)

Iterate entries directly.

let map = Map.create(); let result = map.for ('demo', 'demo'); console.log(result);

Map.NativeMap

The original built-in Map. Use new Map.NativeMap() when you need non-string keys.

let map = Map.create(); let result = Map.NativeMap; console.log(result);