Skip to content

Symbol.iterator

一句话解释

Symbol.iterator 是定义对象默认迭代器的知名 symbol,使 for...of 与展开语法可用。

用大白话说

Symbol.iterator 是一个知名 symbol,把一个方法标记为对象的默认迭代器。当你写 for...of、用展开运算符或对对象调用 Array.from 时,引擎查找 [Symbol.iterator] 并调用它取得迭代器。迭代器是一个含 next() 方法的对象,返回 { value, done }。通过在自己的对象上定义 [Symbol.iterator],你使其可迭代——支持 for...of、展开(...obj)、解构和 Array.from。数组、字符串、Map、Set 和生成器都是这样可迭代的。例如自定义 Range 对象可实现 [Symbol.iterator] 逐个产出范围内的数字,于是 for (const n of range) 可用。生成器是实现迭代器的简洁方式——赋给 [Symbol.iterator] 的生成器函数自动返回迭代器。

示例

javascript
class Range {
  constructor(start, end) { this.start = start; this.end = end; }
  [Symbol.iterator]() {
    let cur = this.start, end = this.end;
    return { next() {
      return cur <= end ? { value: cur++, done: false } : { done: true };
    }};
  }
}

for (const n of new Range(1, 5)) console.log(n); // 1 2 3 4 5
console.log([...new Range(1, 3)]); // [1, 2, 3]

Range 定义 [Symbol.iterator] 返回迭代器对象。现在 for...of 与展开可在 Range 实例上工作。

相关术语

相关资源

相关课程

解读错误信息

用大白话解释常见错误——什么意思、为什么发生、如何修复。

查看错误

← 返回术语表