Set

Set は、primitive valuesでもオブジェクト参照でも、どんな型でも一意の値を格納できます。

The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.

構文

new Set([iterable]);

引数

iterable

iterable object が渡されたら、その要素すべてが新しいSetオブジェクトに追加されます。nullはundefinedとして扱われます。

Return value

A new Set object.

説明

Set オブジェクトは値のコレクションです。挿入順に要素を反復することができます。Set に重複する値は格納出来ません。Set 内の値はコレクション内で一意となります。

値の等価性

Setオブジェクト内の各値は一意でなければならないので、値の等価性が調べられます。初期の ECMAScript では === 演算子とは違うアルゴリズムが用いられていました。特に +0 (-0と厳密に言えば等価です) と-0が区別されていた点は重要です。しかしこの振る舞いは ECMAScript 2015 で変更されました。「-0 と +0 の等価性」については browser compatibility を見て下さい。

また、NaN と undefinedもSet内に格納できます。NaNは(NaN !== NaNですが)NaNと同じと扱われます。

プロパティ

Set.length

lengthの値は0です。

get Set[@@species]

派生オブジェクトを生成するために使用されるコンストラクタ関数。

Set.prototype

Setコンストラクタに対してのプロトタイプを表します。すべてのSetオブジェクトにプロパティを追加できます。

Set インスタンス

すべてのSet インスタンスはSet.prototypeから継承します。

プロパティ

Set.prototype.constructor

Returns the function that created an instance's prototype. This is the Set function by default.

Set.prototype.size

Returns the number of values in the Set object.

メソッド

Set.prototype.add(value)

Appends a new element with the given value to the Set object. Returns the Set object.

Set.prototype.clear()

Removes all elements from the Set object.

Set.prototype.delete(value)

Removes the element associated to the value and returns the value that Set.prototype.has(value) would have previously returned. Set.prototype.has(value) will return false afterwards.

Set.prototype.entries()

Returns a new Iterator object that contains an array of [value, value] for each element in the Set object, in insertion order. This is kept similar to the Map object, so that each entry has the same value for its key and value here.

Set.prototype.forEach(callbackFn[, thisArg])

Calls callbackFn once for each value present in the Set object, in insertion order. If a thisArg parameter is provided to forEach, it will be used as the this value for each callback.

Set.prototype.has(value)

Returns a boolean asserting whether an element is present with the given value in the Set object or not.

Set.prototype.keys()

Is the same function as the values() function and returns a new Iterator object that contains the values for each element in the Set object in insertion order.

Set.prototype.values()

Returns a new Iterator object that contains the values for each element in the Set object in insertion order.

Set.prototype[@@iterator]()

Returns a new Iterator object that contains the values for each element in the Set object in insertion order.

例

Set オブジェクトを使う

var mySet = new Set();

mySet.add(1); // Set [ 1 ]
mySet.add(5); // Set [ 1, 5 ]
mySet.add(5); // Set [ 1, 5 ]
mySet.add('some text'); // Set [ 1, 5, 'some text' ]
var o = {a: 1, b: 2};
mySet.add(o);

mySet.add({a: 1, b: 2}); // o is referencing a different object so this is okay

mySet.has(1); // true
mySet.has(3); // 3 は集合にないため、false
mySet.has(5);              // true
mySet.has(Math.sqrt(25));  // true
mySet.has('Some Text'.toLowerCase()); // true
mySet.has(o); // true

mySet.size; // 5

mySet.delete(5); // 集合から 5 を削除
mySet.has(5);    // 5 が削除されているため false 

mySet.size; // 要素を 1 つ削除しているため 4
console.log(mySet);// Set [ 1, "some text", Object {a: 1, b: 2}, Object {a: 1, b: 2} ]

Setを反復する

// iterate over items in set
// logs the items in the order: 1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2} 
for (let item of mySet) console.log(item);

// logs the items in the order: 1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2} 
for (let item of mySet.keys()) console.log(item);
 
// logs the items in the order: 1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2} 
for (let item of mySet.values()) console.log(item);

// logs the items in the order: 1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2} 
//(key and value are the same here)
for (let [key, value] of mySet.entries()) console.log(key);

// convert Set object to an Array object, with Array.from
var myArr = Array.from(mySet); // [1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2}]

// the following will also work if run in an HTML document
mySet.add(document.body);
mySet.has(document.querySelector('body')); // true

// converting between Set and Array
mySet2 = new Set([1, 2, 3, 4]);
mySet2.size; // 4
[...mySet2]; // [1, 2, 3, 4]

// intersect can be simulated via  
var intersection = new Set([...set1].filter(x => set2.has(x)));

// difference can be simulated via
var difference = new Set([...set1].filter(x => !set2.has(x)));

// Iterate set entries with forEach
mySet.forEach(function(value) {
  console.log(value);
});

// 1
// 2
// 3
// 4

Implementing basic set operations

Set.prototype.isSuperset = function(subset) {
    for (var elem of subset) {
        if (!this.has(elem)) {
            return false;
        }
    }
    return true;
}

Set.prototype.union = function(setB) {
    var union = new Set(this);
    for (var elem of setB) {
        union.add(elem);
    }
    return union;
}

Set.prototype.intersection = function(setB) {
    var intersection = new Set();
    for (var elem of setB) {
        if (this.has(elem)) {
            intersection.add(elem);
        }
    }
    return intersection;
}

Set.prototype.difference = function(setB) {
    var difference = new Set(this);
    for (var elem of setB) {
        difference.delete(elem);
    }
    return difference;
}

//Examples
var setA = new Set([1, 2, 3, 4]),
    setB = new Set([2, 3]),
    setC = new Set([3, 4, 5, 6]);

setA.isSuperset(setB); // => true
setA.union(setC); // => Set [1, 2, 3, 4, 5, 6]
setA.intersection(setC); // => Set [3, 4]
setA.difference(setC); // => Set [1, 2]

Array オブジェクトとの関係

var myArray = ['value1', 'value2', 'value3'];

// Use the regular Set constructor to transform an Array into a Set
var mySet = new Set(myArray);

mySet.has('value1'); // returns true

// Use the spread operator to transform a set into an Array.
console.log([...mySet]); // Will show you exactly the same Array as myArray

Relation with Strings

var text = 'India';

var mySet = new Set(text);  // Set ['I', 'n', 'd', 'i', 'a']
mySet.size;  // 5

仕様

Browser互換性

関連情報

• Map
• WeakMap
• WeakSet