Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【JavaScript ECMAScript】arguments[Symbol.iterator]インスタンスメソッドの使い方

arguments[Symbol.iterator]()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

arguments[Symbol.iterator]()メソッドは、JavaScriptの関数内で利用可能な特殊なargumentsオブジェクトに対して、イテレータを返却するメソッドです。argumentsオブジェクトは、関数に渡された引数にアクセスするための、配列によく似たオブジェクトであり、各引数をインデックスで参照できます。

このメソッドを呼び出すことで、argumentsオブジェクトからイテレータオブジェクトが生成されます。イテレータオブジェクトは、next()メソッドを持つ特殊なオブジェクトで、このnext()メソッドを繰り返し呼び出すことで、argumentsオブジェクトに含まれる引数を一つずつ順番に取り出すことができます。

結果として、argumentsオブジェクトはイテラブルな(反復可能な)オブジェクトとして扱えるようになります。これにより、for...of文やスプレッド構文(...)など、イテラブルな値を受け入れるJavaScriptの構文で、argumentsオブジェクトを直接利用できるようになります。例えば、for (const arg of arguments)のように記述することで、関数に渡されたすべての引数を簡単にループ処理できます。この機能は、関数が受け取る引数の数が決まっていない場合に特に役立ちます。現代のJavaScriptでは、同様の目的でRestパラメータ(...args)の使用が推奨されていますが、既存のコードの理解や特定の状況でこのメソッドの知識は重要です。

公式リファレンス: arguments[Symbol.iterator]()

構文(syntax)

1function myFunction() {
2  const argIterator = arguments[Symbol.iterator]();
3  console.log(argIterator.next().value);
4  console.log(argIterator.next().value);
5}
6
7myFunction('alpha', 'beta', 'gamma');

引数(parameters)

引数なし

引数はありません

戻り値(return)

Iterator

argumentsオブジェクトの要素を順番に処理するためのイテレーターを返します。このイテレーターを使用することで、argumentsオブジェクトの各要素にアクセスできます。

関連コンテンツ