【Node.js24.x】Array::keys()メソッドの使い方
keysメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
keysメソッドは、配列の各インデックス(キー)を順に取得するためのイテレータオブジェクトを返すメソッドです。
このメソッドは、呼び出された配列に存在するすべてのインデックスを表す値を生成し、それを反復処理するための新しいArray Iteratorオブジェクトを返します。具体的には、配列の最初のインデックスである0から始まり、配列の長さから1を引いた値までの整数が順番にイテレータから取り出されます。このイテレータオブジェクトは、for...ofループと組み合わせて使用することで、配列のインデックスを効率的に順番に処理することができます。
例えば、配列の要素自体ではなく、要素が格納されている位置を示すインデックスの情報のみが必要な場合に非常に有用です。これにより、配列の構造を理解したり、特定のインデックスに基づいて処理を分岐させたりする際に、余分な要素のロードや処理を避けることができます。
利用方法としては、まず配列に対してkeys()メソッドを呼び出し、返されたイテレータオブジェクトをfor...ofループのターゲットとして指定します。ループの各イテレーションで、配列の次のインデックスが取得され、処理に利用できます。このメソッドは引数を取らず、常に新しいイテレータオブジェクトを返します。配列の値を反復処理したい場合はvalues()メソッドを、インデックスと値のペアを反復処理したい場合はentries()メソッドを使用するなど、目的に応じたメソッドの使い分けが重要です。戻り値のイテレータは一度消費されると、再度インデックスを反復処理するためにはkeys()メソッドを再度呼び出す必要があります。
構文(syntax)
1const array1 = ['a', 'b', 'c']; 2const iterator = array1.keys(); 3 4for (const key of iterator) { 5 console.log(key); 6}
引数(parameters)
引数なし
引数はありません
戻り値(return)
Array Iterator
Array.prototype.keys() メソッドは、配列の各要素のインデックス(キー)を順に返すイテレータオブジェクトを生成します。このイテレータを使用することで、配列のインデックスを効率的に処理できます。