【JSリファレンス】AsyncIteratorインターフェース

更新日:2024/06/14

Iteratorインターフェースは、オブジェクトを非同期イテレータとして動作させるために必要なプロパティ定義です。

メソッド名戻り値の型内容
nextIteratorResult
で解決する
Promise
次の形式で反復値を返す
反復値あり{done:false , value: 反復値}
反復値なし{done:true , value: undefined}
returnIteratorResult
で解決する
Promise
反復値の取得終了を
イテレーターに通知する。
IteratorResult
{done:true , value: return()の引数}
が推奨される
throw IteratorResult
で拒否(reject)する
Promise
呼び出し元で
エラーが検出されたことを
イテレーターに通知する。
通常は引数としてErrorオブジェクトを受け取る。

IteratorResult
{done:true , value: 何らかの値}
が推奨される

各メソッド共にIteratorResultvalueプロパティの値は、強制ではありませんがPromiseでないことが望まれます。

 

■使用例

  // 500ミリ秒待機するPromise
const sleep500 = (done,value)=> new Promise(
  resolve =>setTimeout( 
    ()=>resolve({
      done:done,
      value:`500ミリ秒待機しました(${value})`
    })
  , 500 )
 );
 
  // 非同期イテレーターを返す関数
const asyncIterator = function(){
  const data = this.data.reverse();

  return {
    next:function(){
      return data.length ? sleep500( false , data.pop() )
        : sleep500( true  );
    }
  }
}
 // 非同期イテラブルなオブジェクト
const obj = {
  data:[1,2,3],
  [Symbol.asyncIterator]:asyncIterator
};

(async ()=>{
  // 値を列挙
  for await( const value of obj ){
    console.log( value );
  }
})();
// 結果:
// 500ミリ秒待機しました(1)
// 500ミリ秒待機しました(2)
// 500ミリ秒待機しました(3)

 

関連ページ

更新日:2024/06/14

書いた人(管理人):けーちゃん

スポンサーリンク

記事の内容について

null

こんにちはけーちゃんです。
説明するのって難しいですね。

「なんか言ってることおかしくない?」
たぶん、こんなご意見あると思います。

裏付けを取りながら記事を作成していますが、僕の勘違いだったり、そもそも情報源の内容が間違えていたりで、正確でないことが多いと思います。
そんなときは、ご意見もらえたら嬉しいです。

掲載コードについては事前に動作確認をしていますが、貼り付け後に体裁を整えるなどをした結果動作しないものになっていることがあります。
生暖かい視線でスルーするか、ご指摘ください。

ご意見、ご指摘はこちら。
https://jsref.affi-sapo-sv.com/info.php

 

このサイトは、リンクフリーです。大歓迎です。