Map
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015 .
* Some parts of this feature may have varying levels of support.
The
Map
object holds key-value pairs and remembers the original insertion order of the keys.
Any value (both objects and
primitive values
) may be used as either a key or a value.
Try it
const map1 = new Map();
map1.set("a", 1);
map1.set("b", 2);
map1.set("c", 3);
console.log(map1.get("a"));
// Expected output: 1
map1.set("a", 97);
console.log(map1.get("a"));
// Expected output: 97
console.log(map1.size);
// Expected output: 3
map1.delete("b");
console.log(map1.size);
// Expected output: 2
Description
Map
objects are collections of key-value pairs. A key in the
Map
may only occur once
; it is unique in the
Map
's collection. A
Map
object is iterated by key-value pairs — a
for...of
loop returns a 2-member array of
[key, value]
for each iteration. Iteration happens in
insertion order
, which corresponds to the order in which each key-value pair was first inserted into the map by the
set()
method (that is, there wasn't a key with the same value already in the map when
set()
was called).
The specification requires maps to be implemented "that, on average, provide access times that are sublinear on the number of elements in the collection". Therefore, it could be represented internally as a hash table (with O(1) lookup), a search tree (with O(log(N)) lookup), or any other data structure, as long as the complexity is better than O(N).
Key equality
Value equality is based on the
SameValueZero
algorithm. (It used to use
SameValue
, which treated
0
and
-0
as different. Check
browser compatibility
.) This means
NaN
is considered the same as
NaN
(even though
NaN !== NaN
) and all other values are considered equal according to the semantics of the
===
operator.
Objects vs. Maps
Object
is similar to
Map
—both let you set keys to
values, retrieve those values, delete keys, and detect whether something is
stored at a key. For this reason (and because there were no built-in
alternatives),
Object
has been used as
Map
historically.
However, there are important differences that make
Map
preferable in some
cases:
Object
may allow
an attacker to override the object's prototype, which can lead to
object injection attacks
. Like the accidental keys issue, this can also be mitigated by using
a
null
-prototype object.
The keys in
Map
are ordered in a straightforward
way: A
Map
object iterates entries, keys, and values in
the order of entry insertion.
Although the keys of an ordinary
Object
are ordered now,
this was not always the case, and the order is complex. As a result,
it's best not to rely on property order.
The order was first defined for own properties only in ECMAScript
2015; ECMAScript 2020 defines order for inherited properties as well.
But note that no single mechanism
iterates
all
of an object's properties; the various mechanisms
each include different subsets of properties.
(
for-in
includes only enumerable string-keyed properties;
Object.keys
includes only own, enumerable,
string-keyed properties;
Object.getOwnPropertyNames
includes own,
string-keyed properties even if non-enumerable;
Object.getOwnPropertySymbols
does the same
for just
Symbol
-keyed properties, etc.)
Object
does not implement an
iteration protocol
, and so objects are not directly iterable using the JavaScript
for...of
statement (by default).
Note:
An object can implement the iteration protocol, or you can get an iterable for an object using
Object.keys
or
Object.entries
.
for...in
statement allows you to iterate over the
enumerable
properties of an object.
No native support for serialization or parsing.
(But you can build your own serialization and parsing support for
Map
by using
JSON.stringify()
with its
replacer
argument, and by using
JSON.parse()
with its
reviver
argument. See the Stack Overflow question
How do you JSON.stringify an ES6 Map?
).
Setting object properties
Setting Object properties works for Map objects as well, and can cause considerable confusion.
Therefore, this appears to work in a way:
const wrongMap = new Map();
wrongMap["bla"] = "blaa";
wrongMap["bla2"] = "blaaa2";
console.log(wrongMap); // Map { bla: 'blaa', bla2: 'blaaa2' }
But that way of setting a property does not interact with the Map data
structure. It uses the feature of the generic object. The value of 'bla' is not
stored in the Map for queries. Other operations on the data fail:
jswrongMap.has("bla"); // false
wrongMap.delete("bla"); // false
console.log(wrongMap); // Map { bla: 'blaa', bla2: 'blaaa2' }
The correct usage for storing data in the Map is through the set(key, value)
method.
jsconst contacts = new Map();
contacts.set("Jessie", { phone: "213-555-1234", address: "123 N 1st Ave" });
contacts.has("Jessie"); // true
contacts.get("Hilary"); // undefined
contacts.set("Hilary", { phone: "617-555-4321", address: "321 S 2nd St" });
contacts.get("Jessie"); // {phone: "213-555-1234", address: "123 N 1st Ave"}
contacts.delete("Raymond"); // false
contacts.delete("Jessie"); // true
console.log(contacts.size); // 1
Map-like browser APIs
Map-like browser APIs
Browser
Map
-like objects
(or "maplike objects") are
Web API
interfaces that behave in many ways like a
Map
.
Just like
Map
, entries can be iterated in the same order that they were added to the object.
Map
-like objects and
Map
also have properties and methods that share the same name and behavior.
However unlike
Map
they only allow specific predefined types for the keys and values of each entry.
The allowed types are set in the specification IDL definition.
For example,
RTCStatsReport
is a
Map
-like object that must use strings for keys and objects for values.
This is defined in the specification IDL below:
webidl
interface RTCStatsReport {
readonly maplike<DOMString, object>;
Map-like objects are either read-only or read-writable (see the readonly keyword in the IDL above).
Read-only Map-like objects have the property size, and the methods: entries(), forEach(), get(), has(), keys(), values(), and Symbol.iterator().
Writeable Map-like objects additionally have the methods: clear(), delete(), and set().
The methods and properties have the same behavior as the equivalent entities in Map, except for the restriction on the types of the keys and values.
The following are examples of read-only Map-like browser objects:
AudioParamMap
RTCStatsReport
EventCounts
KeyboardLayoutMap
MIDIInputMap
MIDIOutputMap
Constructor
Constructor
-
Map()
Creates a new
Map
object.
Static properties
Static properties
-
Map[Symbol.species]
The constructor function that is used to create derived objects.
Static methods
Static methods
-
Map.groupBy()
Groups the elements of a given iterable using the values returned by a provided callback function. The final returned
Map
uses the unique values from the test function as keys, which can be used to get the array of elements in each group.
Instance properties
Instance properties
These properties are defined on
Map.prototype
and shared by all
Map
instances.
Map.prototype.constructor
The constructor function that created the instance object. For
Map
instances, the initial value is the
Map
constructor.
Map.prototype.size
Returns the number of key/value pairs in the
Map
object.
Map.prototype[Symbol.toStringTag]
The initial value of the
[Symbol.toStringTag]
property is the string
"Map"
. This property is used in
Object.prototype.toString()
.
Instance methods
Instance methods
-
Map.prototype.clear() -
Map.prototype.delete() -
Map.prototype.entries() -
Map.prototype.forEach() -
Map.prototype.get() -
Map.prototype.has() -
Map.prototype.keys() -
Map.prototype.set() -
Map.prototype.values() -
Map.prototype[Symbol.iterator]()
Removes all key-value pairs from the
Map
object.
Returns
true
if an element in the
Map
object existed and has been
removed, or
false
if the element does not exist.
map.has(key)
will return
false
afterwards.
Returns a new Iterator object that contains a two-member array of
[key, value]
for each element in the
Map
object in insertion order.
Calls
callbackFn
once for each key-value pair present in the
Map
object, in insertion order. If a
thisArg
parameter is provided to
forEach
, it will be used as the
this
value for each callback.
Returns the value associated to the passed key, or
undefined
if there is none.
Returns a boolean indicating whether a value has been associated with the passed key in the
Map
object or not.
Returns a new Iterator object that contains the keys for each element in the
Map
object in insertion order.
Sets the value for the passed key in the
Map
object. Returns the
Map
object.
Returns a new Iterator object that contains the values for each element in the
Map
object in insertion order.
Returns a new Iterator object that contains a two-member array of
[key, value]
for each element in the
Map
object in insertion order.
Examples
Examples
Using the Map object
Using the Map object
js
const myMap = new Map();
const keyString = "a string";
const keyObj = {};
const keyFunc = () => {};
// 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");
console.log(myMap.size); // 3
// getting the values
console.log(myMap.get(keyString)); // "value associated with 'a string'"
console.log(myMap.get(keyObj)); // "value associated with keyObj"
console.log(myMap.get(keyFunc)); // "value associated with keyFunc"
console.log(myMap.get("a string")); // "value associated with 'a string'", because keyString === 'a string'
console.log(myMap.get({})); // undefined, because keyObj !== {}
console.log(myMap.get(() => {})); // undefined, because keyFunc !== () => {}
Using NaN as Map keys
Using NaN as Map keys
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
NaN
s are indistinguishable from each other:
js
const myMap = new Map();
myMap.set(NaN, "not a number");
myMap.get(NaN);
// "not a number"
const otherNaN = Number("foo");
myMap.get(otherNaN);
// "not a number"
Iterating Map with for...of
Iterating Map with for...of
Maps can be iterated using a
for...of
loop:
js
const myMap = new Map();
myMap.set(0, "zero");
myMap.set(1, "one");
for (const [key, value] of myMap) {
console.log(`${key} = ${value}`);
// 0 = zero
// 1 = one
for (const key of myMap.keys()) {
console.log(key);
for (const value of myMap.values()) {
console.log(value);
// zero
// one
for (const [key, value] of myMap.entries()) {
console.log(`${key} = ${value}`);
// 0 = zero
// 1 = one
Iterating Map with forEach()
Iterating Map with forEach()
Maps can be iterated using the
forEach()
method:
js
myMap.forEach((value, key) => {
console.log(`${key} = ${value}`);
// 0 = zero
// 1 = one
Relation with Array objects
Relation with Array objects
js
const kvArray = [
["key1", "value1"],
["key2", "value2"],
// Use the regular Map constructor to transform a 2D key-value Array into a map
const myMap = new Map(kvArray);
console.log(myMap.get("key1")); // "value1"
// Use Array.from() to transform a map into a 2D key-value Array
console.log(Array.from(myMap)); // Will show you exactly the same Array as kvArray
// A succinct way to do the same, using the spread syntax
console.log([...myMap]);
// Or use the keys() or values() iterators, and convert them to an array
console.log(Array.from(myMap.keys())); // ["key1", "key2"]
Cloning and merging Maps
Cloning and merging Maps
Just like
Array
s,
Map
s can be cloned:
js
const original = new Map([[1, "one"]]);
const clone = new Map(original);
console.log(clone.get(1)); // one
console.log(original === clone); // false (useful for shallow comparison)
Note:
Keep in mind that the data itself is not cloned. In other words, it is only a shallow copy of the Map.
Maps can be merged, maintaining key uniqueness:
jsconst first = new Map([
[1, "one"],
[2, "two"],
[3, "three"],
const second = new Map([
[1, "uno"],
[2, "dos"],
// Merge two maps. The last repeated key wins.
// Spread syntax essentially converts a Map to an Array
const merged = new Map([...first, ...second]);
console.log(merged.get(1)); // uno
console.log(merged.get(2)); // dos
console.log(merged.get(3)); // three
Maps can be merged with Arrays, too:
jsconst first = new Map([
[1, "one"],
[2, "two"],
[3, "three"],
const second = new Map([
[1, "uno"],
[2, "dos"],
// Merge maps with an array. The last repeated key wins.
const merged = new Map([...first, ...second, [1, "un"]]);
console.log(merged.get(1)); // un
console.log(merged.get(2)); // dos
console.log(merged.get(3)); // three
Specifications
Specifications
| Specification |
|---|
|
ECMAScript® 2026 Language Specification
# sec-map-objects |
Browser compatibility
Browser compatibility
See also