Map.prototype.forEach()

The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order.

Try it

Syntax

// Arrow function
forEach(() => { /* … */ } )
forEach((value) => { /* … */ } )
forEach((value, key) => { /* … */ } )
forEach((value, key, map) => { /* … */ } )

// Callback function
forEach(callbackFn)
forEach(callbackFn, thisArg)

// Inline callback function
forEach(function() { /* … */ })
forEach(function(value) { /* … */ })
forEach(function(value, key) { /* … */ })
forEach(function(value, key, map) { /* … */ })
forEach(function(value, key, map) { /* … */ }, thisArg)

Parameters

callbackFn

Function to execute for each entry in the map. It takes the following arguments:

value Optional

Value of each iteration.

key Optional

Key of each iteration.

map Optional

The map being iterated.

thisArg Optional

Value to use as this when executing callback.

Return value

undefined.

Description

The forEach method executes the provided callback once for each key of the map which actually exist. It is not invoked for keys which have been deleted. However, it is executed for values which are present but have the value undefined.

callback is invoked with three arguments:

  • the entry's value
  • the entry's key
  • the Map object being traversed

If a thisArg parameter is provided to forEach, it will be passed to callback when invoked, for use as its this value. Otherwise, the value undefined will be passed for use as its this value. The this value ultimately observable by callback is determined according to the usual rules for determining the this seen by a function.

Each value is visited once, except in the case when it was deleted and re-added before forEach has finished. callback is not invoked for values deleted before being visited. New values added before forEach has finished will be visited.

Examples

Printing the contents of a Map object

The following code logs a line for each element in an Map object:

function logMapElements(value, key, map) {
  console.log(`map.get('${key}') = ${value}`)
}
new Map([['foo', 3], ['bar', {}], ['baz', undefined]]).forEach(logMapElements)
// logs:
// "map.get('foo') = 3"
// "map.get('bar') = [object Object]"
// "map.get('baz') = undefined"

Specifications

Specification
ECMAScript Language Specification
# sec-map.prototype.foreach

Browser compatibility

BCD tables only load in the browser

See also