尝试一下
const iterable1 = {};
iterable1[Symbol.iterator] = function* () {
yield 1;
yield 2;
yield 3;
};
console.log([...iterable1]);
// Expected output: Array [1, 2, 3]
描述
当需要对一个对象进行迭代时（比如开始用于一个 for..of 循环中），它的 [Symbol.iterator]() 方法都会在不传参情况下被调用，返回的迭代器用于获取要迭代的值。
一些内置类型拥有默认的迭代器行为，其他类型（如 Object）则没有。拥有默认的 [Symbol.iterator]() 方法的内置类型是：
Array.prototype[Symbol.iterator]()TypedArray.prototype[Symbol.iterator]()String.prototype[Symbol.iterator]()Map.prototype[Symbol.iterator]()Set.prototype[Symbol.iterator]()
更多信息请参见迭代协议。
Symbol.iterator 的属性特性 | |
|---|---|
| 可写 | 否 |
| 可枚举 | 否 |
| 可配置 | 否 |
示例
自定义迭代器
我们可以像下面这样创建自定义的迭代器：
js
const myIterable = {};
myIterable[Symbol.iterator] = function* () {
yield 1;
yield 2;
yield 3;
};
[...myIterable]; // [1, 2, 3]
或者可以在类或对象中使用计算属性定义迭代：
js
class Foo {
*[Symbol.iterator]() {
yield 1;
yield 2;
yield 3;
}
}
const someObj = {
*[Symbol.iterator]() {
yield "a";
yield "b";
},
};
console.log(...new Foo()); // 1, 2, 3
console.log(...someObj); // 'a', 'b'
不符合标准的迭代器
如果一个迭代器 [Symbol.iterator]() 没有返回一个迭代器对象，那么它就是一个不符合标准的迭代器。这样的迭代器将会在运行期抛出异常，甚至出现非常诡异的 Bug：
js
const nonWellFormedIterable = {};
nonWellFormedIterable[Symbol.iterator] = () => 1;
[...nonWellFormedIterable]; // TypeError: [Symbol.iterator]() returned a non-object value
规范
| 规范 |
|---|
| ECMAScript® 2027 Language Specification # sec-symbol.iterator |