Symbol.iterator
Symbol.iterator 静态数据属性代表 Symbol.iterator 这个知名符号。该可迭代协议会查找此符号，以获取返回对象迭代器的那个方法。为了使对象可迭代，它必须有一个 [Symbol.iterator] 键。
试一试
const iterable = {};
iterable[Symbol.iterator] = function* () {
yield 1;
yield 2;
yield 3;
};
console.log([...iterable]);
// Expected output: Array [1, 2, 3]
值
知名符号 Symbol.iterator。
Symbol.iterator 的属性特性 | |
|---|---|
| 可写 | 否 |
| 可枚举 | 否 |
| 可配置 | 否 |
描述
每当需要迭代一个对象时（例如在 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]()
有关更多信息，请参阅可迭代协议。
示例
用户自定义可迭代对象
我们可以这样创建我们自己的可迭代对象：
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]() 方法没有返回一个迭代器对象，那么它就是一个格式不正确的可迭代对象。这样使用它很可能会导致运行时异常或错误的行为。
js
const nonWellFormedIterable = {};
nonWellFormedIterable[Symbol.iterator] = () => 1;
[...nonWellFormedIterable]; // TypeError: [Symbol.iterator]() returned a non-object value
规范
| 规范 |
|---|
| ECMAScript® 2026 语言规范 # sec-symbol.iterator |
浏览器兼容性
加载中…