Interface IMapOfMutableExtended<V, M>

Like a Map but multiple values can be stored for each key. Duplicate values can be added to the same or even a several keys.

Three pre-defined MapOf's are available:

• ofArrayMutable - Map of arrays
• ofSetMutable - Map of unique items
• ofCircularMutable - Hold a limited set of values per key

Adding

// Add one or more values using the predefined key function to generate a key
map.addValue(value1, value2, ...);
// Add one or more values under a specified key
map.addKeyedValues(key, value1, value2, ...);
Copy

Finding/accessing

// Returns all values stored under key
map.get(key);
// Returns the first key where value is found, or _undefined_ if not found
map.findKeyForValue(value);
// Returns _true_  if value is stored under key
map.hasKeyValue(key, value);
// Returns _true_ if map contains key
map.has(key);
Copy

Removing

// Removes everything
map.clear();
// Delete values under key. Returns _true_ if key was found.
map.delete(key);
// Deletes specified value under key. Returns _true_ if found.
map.deleteKeyValue(key, value);
Copy

Metadata about the map:

map.isEmpty;         // True/false
map.lengthMax;       // Largest count of items under any key
map.count(key);      // Count of items stored under key, or 0 if key is not present.
map.keys();          // Returns a string array of keys
map.keysAndCounts(); // Returns an array of [string,number] for all keys and number of values for each key
map.debugString();   // Returns a human-readable string dump of the contents
Copy

Events can be listened to via addEventListener

• addedKey, addedValue - when a new key is added, or when a new value is added
• clear - when contents are cleared
• deleteKey - when a key is deleted

Example: Event example

map.addEventLister(`addedKey`, ev => {
 // New key evt.key seen.
});
Copy