Symbol.asyncIterator

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

Symbol.asyncIterator 符号指定了一个对象的默认异步迭代器。如果一个对象设置了这个属性，它就是异步可迭代对象，可用于for await...of循环。

描述

Symbol.asyncIterator 是一个用于访问对象的 [Symbol.asyncIterator]() 方法的内建符号。一个异步可迭代对象必须要有 Symbol.asyncIterator 属性。

Symbol.asyncIterator 的属性特性
可写否
可枚举否
可配置否

示例

自定义异步可迭代对象

你可以通过设置[Symbol.asyncIterator]属性来自定义异步可迭代对象。

js
const myAsyncIterable = new Object();
myAsyncIterable[Symbol.asyncIterator] = async function* () {
  yield "hello";
  yield "async";
  yield "iteration!";
};

(async () => {
  for await (const x of myAsyncIterable) {
    console.log(x);
    // expected output:
    //    "hello"
    //    "async"
    //    "iteration!"
  }
})();

内建异步可迭代对象

目前没有默认设定了[Symbol.asyncIterator]属性的 JavaScript 内建的对象。不过，WHATWG（网页超文本应用技术工作小组）Streams 会被设定为第一批异步可迭代对象，[Symbol.asyncIterator] 最近已在设计规范中落地。

规范

Specification
ECMAScript Language Specification
# sec-symbol.asynciterator

浏览器兼容性

BCD tables only load in the browser

参见