【JSリファレンス】%AsyncGeneratorPrototype%.return()

更新日：2024/06/14

%AsyncGeneratorPrototype%.return()は、%AsyncGeneratorPrototype%オブジェクトのメソッドです。

このメソッドは、AsyncGeneratorオブジェクトに非同期イテレーターとしての機能を提供する、AsyncIteratorインターフェースの一部です。

メソッドを実行することで、非同期ジェネレーターに値の取得を終了することを通知します。
以降の%AsyncGeneratorPrototype%.next()呼び出しは、doneプロパティの値がtrueのオブジェクトで解決するPromiseを返します。

 

■構文


%AsyncGeneratorPrototype%.return( value )
  1. value: 履行値のvalueプロパティにセットされる値
次のIteratorResultインターフェースで解決するPromise
{done:true , value: 引数valueの値}

 

■使用例

 // 500ミリ秒待機するPromise
const sleep500 = (value)=> new Promise(
  resolve =>setTimeout( 
    ()=>resolve(
      `500ミリ秒待機しました(${value})`
    )
  , 500 )
 );


  // GeneratorFunctionコンストラクターから
  // GeneratorFunctionオブジェクト生成
const asyncGeneratorFunctionObj = async function*(a,b,c){
   yield sleep500(a);
   yield sleep500(b);
   yield sleep500(c);
};


  // AsyncGeneratorFunctionオブジェクトから
  // AsyncGeneratorオブジェクトを生成
const asyncGenerator = asyncGeneratorFunctionObj(1,2,3);

asyncGenerator.next()
.then(e=>{
    console.log(e);
    return asyncGenerator.next();
  })
.then(e=>{
    console.log(e);
    return asyncGenerator.return(100);
  })
.then(e=>{
    console.log(e);
    return asyncGenerator.next();
  });
// 結果:
// { value: '500ミリ秒待機しました(1)', done: false }
// { value: '500ミリ秒待機しました(2)', done: false }
// { value: 100, done: true }

更新日：2024/06/14

書いた人（管理人）：けーちゃん

スポンサーリンク

記事の内容について

null

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

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

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

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

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

 

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