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

【JavaScript ECMAScript】Set::Set.prototype.keysインスタンスメソッドの使い方

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

作成日: 更新日:

基本的な使い方

Set.prototype.keys()メソッドは、Setオブジェクトに格納されているすべての要素(値)を挿入順に返す新しいイテレーターオブジェクトを実行するメソッドです。JavaScriptにおいてSetオブジェクトとは、重複する値を許容しない、ユニークな値のコレクションを扱うための組み込みオブジェクトです。このkeys()メソッドを使用することで、Setオブジェクト内にどのような値が格納されているかを一つずつ確認したり、それらの値に対して何らかの処理を実行したりすることが可能になります。

このメソッドが返すイテレーターオブジェクトは、for...ofループと組み合わせて使うことで、Setオブジェクトの各要素を順番に取り出して処理することができます。例えば、特定のリストから重複する項目を削除してユニークな項目だけにした後、そのユニークな項目すべてに対して何らかの操作を行いたい場合に非常に役立ちます。Setオブジェクトにはキーと値という概念がありませんが、便宜上Set.prototype.keys()は値自身をキーとして扱い、値を返します。このため、Set.prototype.values()メソッドと全く同じイテレーターを返す点も特徴です。このメソッドは、Set内のユニークな値を効率的に参照し、操作するための重要な手段の一つです。

公式リファレンス: Set.prototype.keys()

構文(syntax)

1const mySet = new Set();
2mySet.add('value1');
3mySet.add('value2');
4mySet.add('value3');
5
6const iterator = mySet.keys();
7
8for (const key of iterator) {
9  console.log(key);
10}

引数(parameters)

引数なし

引数はありません

戻り値(return)

SetIterator

Set.prototype.keys() は、Set オブジェクトの各要素のキーを順番に返す SetIterator オブジェクトを生成します。Set オブジェクトでは要素そのものがキーとなるため、このメソッドは要素のイテレータを返します。

関連コンテンツ

関連プログラミング言語