WeakMap

The WeakMap object is a collection of key/value pairs in which the keys are weakly referenced.  The keys must be objects and the values can be arbitrary values.

You can learn more about WeakMaps in the section WeakMap object in キー付きコレクション.

構文

new WeakMap([iterable])

引数

iterable

要素がキー・値の対（2 要素の配列）である Array または他の反復処理可能なオブジェクトです。それぞれのキー・値対が新しい WeakMap に追加されます。null は undefined として扱われます。

説明

WeakMap のキーは Object に限ります。プリミティブ型 はキーとして使えません（例えば Symbol は WeakMap のキーとして使えません）。

なぜ WeakMap なのか?

map API は、4 つの API メソッドから共有される 2 つの配列（ 1 つはキー用、もう 1 つは値用）を用いることで、JavaScript で実装できます。Setting elements on this map would involve pushing a key and value onto the end of each of those arrays simultaneously. As a result, the indices of the key and value would correspond to both arrays.  Getting values from the map would involve iterating through all keys to find a match, then using the index of this match to retrieve the corresponding value from the array of values. 

そうした実装では、主に 2 つの不都合が生じることとなります。1 つ目の不都合は、探索の計算量が O(n) となること (O(n) search)（n はマップ中におけるキーの数を表す）。もう 1 つの不都合はメモリーリークの問題です。（2 つの配列を使って）マップを自作した場合、キーの配列はキーとしたオブジェクトへの参照を保持し続けるでしょう。従って、それらのキーとなったオブジェクトはガベージコレクションの対象から外されることとなります。

ネイティブな WeakMap では、キーとなるオブジェクトに対しては"弱い"参照が保持されます。これにより、キーとなったオブジェクトへの参照が他に存在しない場合に、そのオブジェクトはガベージコレクションの対象に含まれるようになります。Native WeakMaps can be particularly useful constructs when mapping keys to information about the key that is valuable only if the key has not been garbage collected.

弱参照を用いるため、WeakMap のキーは列挙できません（つまり、キーの一覧を取得するメソッドは存在しません）。もし、可能であれば、キーの一覧はガベージコレクションに依存することになり、非決定性が生まれます。キーの一覧が必要な場合は、Mapを使うことになります。

プロパティ

WeakMap.length

The value of the length property is 0.

WeakMap.prototype

Represents the prototype for the WeakMap constructor. Allows the addition of properties to all WeakMap objects.

WeakMap インスタンス

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

プロパティ

WeakMap.prototype.constructor

インスタンスのプロトタイプを生成する関数を返します。これは、デフォルトではWeakMap 関数です。

メソッド

WeakMap.prototype.delete(key)

key に関連した値を削除します。その後 WeakMap.prototype.has(key) は false を返します。

WeakMap.prototype.get(key)

key に関連した値を返します。見つからない場合、undefined を返します。

WeakMap.prototype.has(key)

WeakMap オブジェクト内に key に関連した値があるかどうか示す Boolean を返します。

WeakMap.prototype.set(key, value)

WeakMap オブジェクト内に key に対する値を設定し、WeakMap オブジェクトを返します。

WeakMap.prototype.clear()

WeakMap オブジェクトからすべてのキー／バリューペアを削除します。.clear() メソッドを持っていない WeakMap オブジェクトをカプセル化することによって、.clear() メソッドを持つ WeakMap オブジェクトに似たオブジェクトを実装することが可能であることに注意してください。(WeakMap ページの例を確認してください。)

例

WeakMap を使う

var wm1 = new WeakMap(),
    wm2 = new WeakMap(),
    wm3 = new WeakMap();
var o1 = {},
    o2 = function(){},
    o3 = window;

wm1.set(o1, 37);
wm1.set(o2, "azerty");
wm2.set(o1, o2); // 値は（オブジェクトまたは関数を含む）何であってもかまいません
wm2.set(o3, undefined);
wm2.set(wm1, wm2); // キーも値もどんなオブジェクトでもかまいません。WeakMap であってもよいのです！

wm1.get(o2); // "azerty"
wm2.get(o2); // wm2 には o2 に関連付けられた値が無い為、undefined が返ってきます
wm2.get(o3); // 値が undefined と関連付けられている為、undefined が返ってきます

wm1.has(o2); // true
wm2.has(o2); // false
wm2.has(o3); // true (値が関連付けられているならば、たとえ値が 'undefined' であっても true となります)

wm3.set(o1, 37);
wm3.get(o1); // 37

wm1.has(o1);   // true
wm1.delete(o1);
wm1.has(o1);   // false

Implementing a WeakMap-like class with a .clear() method

class ClearableWeakMap {
  constructor(init) {
    this._wm = new WeakMap(init)
  }
  clear() {
    this._wm = new WeakMap()
  }
  delete(k) {
    return this._wm.delete(k)
  }
  get(k) {
    return this._wm.get(k)
  }
  has(k) {
    return this._wm.has(k)
  }
  set(k, v) {
    this._wm.set(k, v)
    return this
  }
}

仕様

ブラウザー実装状況

関連情報

• WeakMap in the JavaScript guide
• WeakMap に関する bugzilla.mozilla.org 上の bug
• Map
• Set
• WeakSet