WeakSet

概要

コレクションとして弱保持されたobjectsを格納します。

構文

 new WeakSet([iterable]);

引数

iterable

iterable object が渡された場合、すべての要素は、新しいWeakSetに追加されます。nullはundefinedとして扱われます。

説明

WeakSetオブジェクトはコレクションオブジェクトです。WeakSet内のオブジェクトは一度だけ発生します。すなわち、WeakSetコレクション内で唯一の要素になります。

Setオブジェクトとの主な違いは下記の通りです。:

• Setとの対比で、WeakSetsはオブジェクトのみのコレクションです。すべての型の任意の値のコレクションではありません。
• WeakSetはweakです。: コレクション内のオブジェクトへの参照は弱保持です。WeakSet内に格納されているオブジェクトへの参照が他にない場合、ガベージコレクションされます。これは、コレクション内に格納されている現在のオブジェクトのリストがないことを意味します。WeakSetsは列挙されません。

Detecting circular references

Functions that call themselves recursively need a way of guarding against circular data structures by tracking which objects have already been processed. WeakSets are ideal for this purpose:

// Execute a callback on everything stored inside an object
function execRecursively(fn, subject, _refs = null){
	if(!_refs)
		_refs = new WeakSet();
	
	// Avoid infinite recursion
	if(_refs.has(subject))
		return;

	fn(subject);
	if("object" === typeof subject){
		_refs.add(subject);
		for(let key in subject)
			execRecursively(fn, subject[key], _refs);
	}
}

const foo = {
	foo: "Foo",
	bar: {
		bar: "Bar"
	}
};

foo.bar.baz = foo; // Circular reference!
execRecursively(obj => console.log(obj), foo);

Here, a WeakSet is created on the first run, and passed along with every subsequent function call (using the internal _refs parameter). The number of objects or their traversal order is immaterial, so a WeakSet is more suitable (and performant) than a Set for tracking object references, especially if a very large number of objects is involved.

コンストラクタ

WeakSet()

Creates a new WeakSet object.

プロパティ

WeakSet.length

lengthプロパティの値は0です。

WeakSet.prototype

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

WeakSet インスタンス

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

プロパティ

WeakSet.prototype.constructor

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

メソッド

WeakSet.prototype.add(value)

Appends a new object with the given value to the WeakSet object.

WeakSet.prototype.delete(value)

Removes the element associated to the value. WeakSet.prototype.has(value) will return false afterwards.

WeakSet.prototype.has(value)

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

WeakSet.prototype.clear()

Removes all elements from the WeakSet object.

例

例: WeakSet オブジェクトを使う

const ws = new WeakSet();
const foo = {};
const bar = {};

ws.add(foo);
ws.add(bar);

ws.has(foo);    // true
ws.has(bar);    // true

ws.delete(foo); // removes foo from the set
ws.has(foo);    // false, foo has been removed
ws.has(bar);    // true, bar is retained

Note that foo !== bar. While they are similar objects, they are not the same object. And so they are both added to the set.

仕様

ブラウザ実装状況

関連情報

• Map
• Set
• WeakMap