Class: Map

var Map = caph.require('collection.Map');
 var map = new Map;

Methods

delete(key)

Deletes a key/value pair from the map.

Parameters:

Name	Type	Description
key	Object	The value will be used find key in Map. if it exists, the key/value pair will be deleted.

Since:

• 2.1.0

Example

var Map = caph.require('collection.Map');
 var map = new Map;
 var key = {}, value={};
 map.set(key, value);
 map.delete(key);

get(key) → {Object}

Gets value in Map by key

Parameters:

Name	Type	Description
key	Object	The key will be used find value in Map

Since:

• 2.0.0

Returns:

Returns value from Map

Type

Object

Example

var Map = caph.require('collection.Map');
 var map = new Map;
 var key = {}, value={};
 map.set(key, value);
 map.get(key);        //value will be returned

getKeyByValue(value) → {Object}

Gets a paired key by a value. This returns the first searched value if the same value exists in the map.

Parameters:

Name	Type	Description
value	Object	The value will be used find key in Map

Since:

• 2.0.0

Returns:

Returns key from Map

Type

Object

Example

var Map = caph.require('collection.Map');
 var map = new Map;
 var key = {}, value={};
 map.set(key, value);
 map.getKeyByValue(value);        //key will be returned

set(key, value) → {Object}

Sets key & value pair into Map

Parameters:

Name	Type	Description
key	Object	The key will be inserted into Map as key, key and value is pair
value	Object	The value will be inserted into Map as value, key and value is pair

Since:

• 2.0.0

Returns:

value Returns the value bound with the given key.

Type

Object

Example

var Map = caph.require('collection.Map');
 var map = new Map;
 var key = {}, value={};
 map.set(key, value);