30 Maps (Map)

Before ES6, JavaScript didn’t have a data structure for dictionaries and (ab)used objects as dictionaries from strings to arbitrary values. ES6 brought Maps, which are dictionaries from arbitrary values to arbitrary values.

30.1 Using Maps

An instance of Map maps keys to values. A single key-value mapping is called an entry.

30.1.1 Creating Maps

There are three common ways of creating Maps.

First, you can use the constructor without any parameters to create an empty Map:

const emptyMap = new Map();
assert.equal(emptyMap.size, 0);

Second, you can pass an iterable (e.g. an Array) over key-value “pairs” (Arrays with 2 elements) to the constructor:

const map = new Map([
  [ 1, 'one' ],
  [ 2, 'two' ],
  [ 3, 'three' ], // trailing comma is ignored
]);

Third, the .set() method adds entries to a Map and is chainable:

const map = new Map()
.set(1, 'one')
.set(2, 'two')
.set(3, 'three');

30.1.2 Working with single entries

.set() and .get() are for writing and reading values (given keys).

const map = new Map();

map.set('foo', 123);

assert.equal(map.get('foo'), 123);
// Unknown key:
assert.equal(map.get('bar'), undefined);
// Use the default value '' if an entry is missing:
assert.equal(map.get('bar') || '', '');

.has() checks if a Map has an entry with a given key. .delete() removes entries.

const map = new Map([['foo', 123]]);

assert.equal(map.has('foo'), true);
assert.equal(map.delete('foo'), true)
assert.equal(map.has('foo'), false)

30.1.3 Determining the size of a Map and clearing it

.size contains the number of entries in a Map. .clear() removes all entries of a Map.

const map = new Map()
  .set('foo', true)
  .set('bar', false)
;

assert.equal(map.size, 2)
map.clear();
assert.equal(map.size, 0)

30.1.4 Getting the keys and values of a Map

.keys() returns an iterable over the keys of a Map:

const map = new Map()
  .set(false, 'no')
  .set(true, 'yes')
;

for (const key of map.keys()) {
  console.log(key);
}
// Output:
// false
// true

We can use spreading (...) to convert the iterable returned by .keys() to an Array:

assert.deepEqual(
  [...map.keys()], 
  [false, true]);

.values() works like .keys(), but for values instead of keys.

30.1.5 Getting the entries of a Map

.entries() returns an iterable over the entries of a Map:

const map = new Map()
  .set(false, 'no')
  .set(true, 'yes')
;

for (const entry of map.entries()) {
  console.log(entry);
}
// Output:
// [false, 'no']
// [true, 'yes']

Spreading (...) converts the iterable returned by .entries() to an Array:

assert.deepEqual(
  [...map.entries()], 
  [[false, 'no'], [true, 'yes']]);

Map instances are also iterables over entries. In the following code, we use destructuring to access the keys and values of map:

for (const [key, value] of map) {
  console.log(key, value);
}
// Output:
// false, 'no'
// true, 'yes'

30.1.6 Listed in insertion order: entries, keys, values

Maps record in which order entries were created and honor that order when listing entries, keys or values:

const map1 = new Map([
  ['a', 1],
  ['b', 2],
]);
assert.deepEqual(
  [...map1.keys()], ['a', 'b']);

const map2 = new Map([
  ['b', 2],
  ['a', 1],
]);
assert.deepEqual(
  [...map2.keys()], ['b', 'a']);

30.1.7 Converting between Maps and Objects

As long as a Map only uses strings and symbols as keys, you can convert it to an object (via Object.entries()):

const map = new Map([
  ['a', 1],
  ['b', 2],
]);
const obj = Object.fromEntries(map);
assert.deepEqual(
  obj, {a: 1, b: 2});

You can also convert an object to a Map with string or symbol keys (via Object.fromEntries()):

const obj = {
  a: 1,
  b: 2,
};
const map = new Map(Object.entries(obj));
assert.deepEqual(
  map, new Map([['a', 1], ['b', 2]]));

30.2 Example: Counting characters

countChars() returns a Map that maps characters to numbers of occurrences.

function countChars(chars) {
  const charCounts = new Map();
  for (let ch of chars) {
    ch = ch.toLowerCase();
    const prevCount = charCounts.get(ch) || 0;
    charCounts.set(ch, prevCount+1);
  }
  return charCounts;
}

const result = countChars('AaBccc');
assert.deepEqual(
  [...result],
  [
    ['a', 2],
    ['b', 1],
    ['c', 3],
  ]
);

30.3 A few more details about the keys of Maps (advanced)

Any value can be a key, even an object:

const map = new Map();

const KEY1 = {};
const KEY2 = {};

map.set(KEY1, 'hello');
map.set(KEY2, 'world');

assert.equal(map.get(KEY1), 'hello');
assert.equal(map.get(KEY2), 'world');

30.3.1 What keys are considered equal?

Most Map operations need to check whether a value is equal to one of the keys. They do so via the internal operation SameValueZero, which works like ===, but considers NaN to be equal to itself.

As a consequence, you can use NaN as a key in Maps, just like any other value:

> const map = new Map();

> map.set(NaN, 123);
> map.get(NaN)
123

Different objects are always considered to be different. That is something that can’t be changed (yet – configuring key equality is on TC39’s long term roadmap).

> new Map().set({}, 1).set({}, 2).size
2

30.4 Missing Map operations

30.4.1 Mapping and filtering Maps

You can .map() and .filter() an Array, but there are no such operations for a Map. The solution is:

1. Convert the Map into an Array of [key,value] pairs.
2. Map or filter the Array.
3. Convert the result back to a Map.

I’ll use the following Map to demonstrate how that works.

const originalMap = new Map()
.set(1, 'a')
.set(2, 'b')
.set(3, 'c');

Mapping originalMap:

const mappedMap = new Map( // step 3
    [...originalMap] // step 1
    .map(([k, v]) => [k * 2, '_' + v]) // step 2
);
assert.deepEqual([...mappedMap],
  [[2,'_a'], [4,'_b'], [6,'_c']]);

Filtering originalMap:

const filteredMap = new Map( // step 3
    [...originalMap] // step 1
    .filter(([k, v]) => k < 3) // step 2
);
assert.deepEqual([...filteredMap],
  [[1,'a'], [2,'b']]);

Step 1 is performed by spreading (...) in the Array literal.

30.4.2 Combining Maps

There are no methods for combining Maps, which is why we must use a work-around that is similar to the one from the previous section.

Let’s combine the following two Maps:

const map1 = new Map()
  .set(1, '1a')
  .set(2, '1b')
  .set(3, '1c')
;

const map2 = new Map()
  .set(2, '2b')
  .set(3, '2c')
  .set(4, '2d')
;

To combine map1 and map2, we turn them into Arrays via spreading (...) and concatenate those Arrays. Afterwards, we convert the result back to a Map. All of that is done in line A.

const combinedMap = new Map([...map1, ...map2]); // (A)
assert.deepEqual(
  [...combinedMap], // convert to Array for comparison
  [ [ 1, '1a' ],
    [ 2, '2b' ],
    [ 3, '2c' ],
    [ 4, '2d' ] ]
);

30.5 Quick reference: Map<K,V>

Note: For the sake of conciseness, I’m pretending that all keys have the same type K and that all values have the same type V.

30.5.1 Constructor

• new Map<K, V>(entries?: Iterable<[K, V]>) ^[ES6]

  If you don’t provide the parameter entries, then an empty Map is created. If you do provide an iterable over [key, value] pairs, then those pairs added as entries to the Map. For example:

  const map = new Map([
    [ 1, 'one' ],
    [ 2, 'two' ],
    [ 3, 'three' ], // trailing comma is ignored
  ]);

30.5.2 Map<K,V>.prototype: handling single entries

• .get(key: K): V ^[ES6]

  Returns the value that key is mapped to in this Map. If there is no key key in this Map, undefined is returned.

  const map = new Map([[1, 'one'], [2, 'two']]);
  assert.equal(map.get(1), 'one');
  assert.equal(map.get(5), undefined);

• .set(key: K, value: V): this ^[ES6]

  Maps the given key to the given value. If there is already an entry whose key is key, it is updated. Otherwise, a new entry is created. This method returns this, which means that you can chain it.

  const map = new Map([[1, 'one'], [2, 'two']]);
  map.set(1, 'ONE!')
     .set(3, 'THREE!');
  assert.deepEqual(
    [...map.entries()],
    [[1, 'ONE!'], [2, 'two'], [3, 'THREE!']]);

• .has(key: K): boolean ^[ES6]

  Returns whether the given key exists in this Map.

  const map = new Map([[1, 'one'], [2, 'two']]);
  assert.equal(map.has(1), true); // key exists
  assert.equal(map.has(5), false); // key does not exist

• .delete(key: K): boolean ^[ES6]

  If there is an entry whose key is key, it is removed and true is returned. Otherwise, nothing happens and false is returned.

  const map = new Map([[1, 'one'], [2, 'two']]);
  assert.equal(map.delete(1), true);
  assert.equal(map.delete(5), false); // nothing happens
  assert.deepEqual(
    [...map.entries()],
    [[2, 'two']]);

30.5.3 Map<K,V>.prototype: handling all entries

• get .size: number ^[ES6]

  Returns how many entries this Map has.

  const map = new Map([[1, 'one'], [2, 'two']]);
  assert.equal(map.size, 2);

• .clear(): void ^[ES6]

  Removes all entries from this Map.

  const map = new Map([[1, 'one'], [2, 'two']]);
  assert.equal(map.size, 2);
  map.clear();
  assert.equal(map.size, 0);

30.5.4 Map<K,V>.prototype: iterating and looping

Both iterating and looping happen in the order in which entries were added to a Map.

• .entries(): Iterable<[K,V]> ^[ES6]

  Returns an iterable with one [key,value] pair for each entry in this Map. The pairs are Arrays of length 2.

  const map = new Map([[1, 'one'], [2, 'two']]);
  for (const entry of map.entries()) {
    console.log(entry);
  }
  // Output:
  // [1, 'one']
  // [2, 'two']

• .forEach(callback: (value: V, key: K, theMap: Map<K,V>) => void, thisArg?: any): void ^[ES6]

  The first parameter is a callback that is invoked once for each entry in this Map. If thisArg is provided, this is set to it for each invocation. Otherwise, this is set to undefined.

  const map = new Map([[1, 'one'], [2, 'two']]);
  map.forEach((value, key) => console.log(value, key));
  // Output:
  // 'one', 1
  // 'two', 2

• .keys(): Iterable<K> ^[ES6]

  Returns an iterable over all keys in this Map.

  const map = new Map([[1, 'one'], [2, 'two']]);
  for (const key of map.keys()) {
    console.log(key);
  }
  // Output:
  // 1
  // 2

• .values(): Iterable<V> ^[ES6]

  Returns an iterable over all values in this Map.

  const map = new Map([[1, 'one'], [2, 'two']]);
  for (const value of map.values()) {
    console.log(value);
  }
  // Output:
  // 'one'
  // 'two'

• [Symbol.iterator](): Iterable<[K,V]> ^[ES6]

  The default way of iterating over Maps. Same as .entries().

  const map = new Map([[1, 'one'], [2, 'two']]);
  for (const [key, value] of map) {
    console.log(key, value);
  }
  // Output:
  // 1, 'one'
  // 2, 'two'

30.5.5 Sources of this section

• TypeScript’s built-in typings

30.6 FAQ: Maps

30.6.1 When should I use a Map, when an object?

If you need a dictionary-like data structure with keys that are neither strings nor symbols, you have no choice: you must use a Map.

If, however, your keys are either strings or symbols, you must decide whether or not to use an object. A rough general guideline is:

• Is there a fixed set of keys (known at development time)?

  Then use an object obj and access the values via fixed keys:

  const value = obj.key;

• Can the set of keys change at runtime?

  Then use a Map map and access the values via keys stored in variables:

  const theKey = 123;
  map.get(theKey);

30.6.2 When would I use an object as a key in a Map?

You normally want Map keys to be compared by value (two keys are considered equal if they have the same content). That excludes objects. However, there is one use case for objects as keys: externally attaching data to objects. But that use case is served better by WeakMaps, where entries don’t prevent keys from being garbage-collected (for details, consult the next chapter).

30.6.3 Why do Maps preserve the insertion order of entries?

In principle, Maps are unordered. The main reason for ordering entries is so that operations that list entries, keys or values, are deterministic. That helps, e.g., with testing.

30.6.4 Why do Maps have a .size, while Arrays have a .length?

In JavaScript, indexable sequences (such as Arrays) have a .length, while mainly unordered collections (such as Maps) have a .size.