【JavaScript ECMAScript】Map::Map.prototype.keysインスタンスメソッドの使い方
Map.prototype.keys()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
Map.prototype.keys()メソッドは、Mapオブジェクト内に格納されているすべてのキーを、挿入順に新しいIteratorオブジェクトとして返すメソッドです。Mapは、キーと値のペアを対応付けてデータを保持するコレクションであり、このメソッドを使用することで、そのMapにどのような「鍵」が登録されているのかを一覧で取得することができます。
返されるIteratorオブジェクトは、反復可能プロトコルに準拠しており、例えばJavaScriptのfor...ofループを利用して、Map内の各キーに順番にアクセスすることが可能です。これにより、Mapに格納されているキーのセットを効率的に走査したり、特定のキーが存在するかどうかを確認したり、それぞれのキーに対して何らかの処理を実行したりする際に非常に役立ちます。
このメソッドが返すキーの順序は、Mapに要素が挿入された順序と同じです。Mapオブジェクト自体は変更されず、あくまでキーの情報のみを抽出して提供します。例えば、アプリケーションの設定値を保持するMapから、設定項目名の一覧だけを抜き出して表示するといったシナリオで利用できます。このように、Mapオブジェクトの構造を保ちつつ、そのキーの部分に注目して操作を行うための強力な手段となるでしょう。
公式リファレンス: Map.prototype.keys()
構文(syntax)
1const myMap = new Map(); 2const keyIterator = myMap.keys();
引数(parameters)
引数なし
引数はありません
戻り値(return)
MapIterator
Map.prototype.keys()は、Mapオブジェクトのキーを順に格納したMapIteratorオブジェクトを返します。このイテレーターを使用することで、Mapに含まれる各キーを順番に取り出すことができます。