Symbol.asyncIterator

Symbol.asyncIterator シンボルは、オブジェクトの @@asyncIterator メソッドにアクセスするための組み込みシンボルです。オブジェクトを非同期で反復可能にするには、Symbol.asyncIterator キーが必要です。

オブジェクトに [Symbol.asyncIterator] プロパティを設定することで、独自の非同期イテレータを定義することができます。

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

(async () => {
  for await (const x of myAsyncIterable) {
    console.log(x);
    // 期待される出力:
    // "hello"
    // "async"
    // "iteration!"
  }
})();

API を作成するとき、非同期反復可能項目はデータのストリームやリストのような、反復可能なものを表すために設計されたものであり、ほとんどの状況でコールバックやイベントを完全に置き換えるものではないことに注意してください。

現在のところ、デフォルトで [Symbol.asyncIterator] キーが設定されている組み込み JavaScript オブジェクトはありません。しかし、WHATWG Streams は非同期反復可能な最初の組み込みオブジェクトになるように設定されており、最近 [Symbol.asyncIterator] が仕様に組み込まれました。

• 反復処理プロトコル
• for await... of