Map.prototype[Symbol.iterator]()

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.

Map 实例的 [Symbol.iterator]() 方法实现了可迭代协议以允许 Map 对象被大多数语法所接受，例如展开语法和 for...of 循环。它返回一个 map 迭代器对象，此对象会以插入顺序生成 map 的键值对。

该属性的初始值与 Map.prototype.entries 属性的初始值是同一个函数对象。

尝试一下

语法

js
map[Symbol.iterator]()

参数

无。

返回值

与 Map.prototype.entries() 返回值相同：一个新的迭代器对象，它会以插入顺序生成 map 的键值对。

示例

使用 for...of 循环进行迭代

请注意，通常你不需要直接调用此方法。[Symbol.iterator]() 方法的存在使得 Map 对象可迭代，而像 for...of 循环这样的迭代语法会自动调用此方法以获取用于循环的迭代器。

js
const myMap = new Map();
myMap.set("0", "foo");
myMap.set(1, "bar");
myMap.set({}, "baz");

for (const entry of myMap) {
  console.log(entry);
}
// ["0", "foo"]
// [1, "bar"]
// [{}, "baz"]

for (const [key, value] of myMap) {
  console.log(`${key}: ${value}`);
}
// 0: foo
// 1: bar
// [Object]: baz

手动控制迭代器

你仍然可以手动调用返回的迭代器对象的 next() 方法来获得最大程度的控制权。

js
const myMap = new Map();
myMap.set("0", "foo");
myMap.set(1, "bar");
myMap.set({}, "baz");

const mapIter = myMap[Symbol.iterator]();

console.log(mapIter.next().value); // ["0", "foo"]
console.log(mapIter.next().value); // [1, "bar"]
console.log(mapIter.next().value); // [Object, "baz"]

规范

Specification
ECMAScript Language Specification
# sec-map.prototype-%symbol.iterator%

浏览器兼容性

BCD tables only load in the browser

参见