This content covers features introduced in Firefox 13
Non-standard
Warning: The SpiderMonkey Map implementation is a prototype and the Map API and semantics specifications are unstable. The SpiderMonkey implementation may not reflect the latest specification draft. It is subject to change anytime. It is provided as an experimental feature. Do not rely on it for production code.
Introduction
Map objects are simple key/value maps. Any value (both objects and primitive values) may be used as either a key or a value. Key equality is based on the "same-value" algorithm: NaN is considered the same as NaN (even though NaN !== NaN), -0 and +0 are considered distinct (even though -0 === +0), and all other values are considered equal according to the semantics of the === operator.
API
| Method | Description |
|---|---|
myMap.get(key) | Returns the value associated to the key, or undefined if there is none. |
myMap.set(key, value) | Sets the value for the key in myMap. Returns undefined. |
myMap.has(key) | Returns a boolean asserting whether a value has been associated to the key in myMap or not |
myMap.delete(key) | Removes any value associated to the key. After such a call, myMap.has(key) will return false. |
myMap.size() | Returns the number of key/value pairs in myMap. |
It is expected that the final version of ECMAScript 6 will allow for iterating over maps and enumerating their keys. As these features are currently not specified, they are not supported in SpiderMonkey.
Examples
var myMap = new Map();
var keyObj = {},
keyFunc = function () {},
keyString = "a string";
// setting the values
myMap.set(keyString, "value associated with 'a string'");
myMap.set(keyObj, "value associated with keyObj");
myMap.set(keyFunc, "value associated with keyFunc");
myMap.size(); // 3
// getting the values
myMap.get(keyString); // "value associated with 'a string'"
myMap.get(keyObj); // "value associated with keyObj"
myMap.get(keyFunc); // "value associated with keyFunc"
myMap.get("a string"); // "value associated with 'a string'"
// because keyString === 'a string'
myMap.get({}); // undefined, because keyObj !== {}
myMap.get(function() {}) // undefined, because keyFunc !== function () {}
NaN can also be used as a key. Even though every NaN is not equal to itself (NaN !== NaN is true), the following example works, because NaNs are indistinguishable from each other:
var myMap = new Map();
myMap.set(NaN, "not a number");
myMap.get(NaN); // "not a number"
var otherNaN = Number("foo");
myMap.get(otherNaN); // "not a number"
Also note that JavaScript has two zero values, +0 and -0. These two zero values are treated as different keys in Maps:
var myMap = new Map(); myMap.set(0, "positive zero"); myMap.set(-0, "negative zero"); 0 === -0; // true myMap.get(-0); // "negative zero" myMap.get(0); // "positive zero"
Objects and maps compared
Objects are similar to Maps in that both let you set keys to values, retrieve those values, delete keys, and detect whether something is stored at a key. Because of this, Objects have been used as Maps historically; however, there are important differences between Objects and Maps that make using a Map better.
- An
Objecthas a prototype, so there are default keys in the map. However, this can be bypassed usingmap = Object.create(null). - The keys of an
Objectare Strings, where they can be any value for aMap. - You can get the size of a
Mapeasily while you have to manually keep track of size for anObject.
Use maps over objects when keys are unknown until run time, and when all keys are the same type and all values are the same type.
Use objects when there is logic that operates on individual elements.
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|
| Basic support | -- | 13.0 (13) | -- | -- | -- |
| Feature | Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|
| Basic support | -- | 13.0 (13) | -- | -- | -- |
Mozilla Developer Network