L'objetWeakMap représente une collection de paires clé-valeur dont les clés sont des objets et pour lesquelles les références sont « faibles » et les valeurs des valeurs quelconques.

Vous pouvez en savoir plus sur lesWeakMap en lisant l'article surles collections à clé.

Description

Les clés des objetsWeakMap sont nécessairement du typeObject.Des types de données primitifs ne sont pas autorisés pour les clés (ex : unSymbol ne peut pas être une clé dans unWeakMap).

Les clés d'uneWeakMap sont référencéesfaiblement. Cela signifie que s'il n'existe aucune autre référence « forte » vers la clé, l'élément (la clé et la valeur) sera retiré de laWeakMap par le ramasse-miettes.

Pourquoi WeakMap ?

Avec un certain recul, on peut voir que cette API aurait pu être implémentée en JavaScript grâce à deux tableaux (un tableau pour stocker les clés, l'autre pour les valeurs) associées à 4 méthodes.

Une telle implémentation présente deux inconvénients principaux :

1. Le premier est que la recherche serait effectuée en O(n) (avec n le nombre de clés).

2. Le second inconvénient concerne les fuites mémoires. Si la carte (map) est construite manuellement, le tableau contenant les clés serait obligé de garder les références vers les objets que sont les clés, ce qui les empêcherait d'être nettoyés par le ramasse-miette.

Grâce aux objets natifsWeakMap, les références vers les clés sont faibles (weak) ce qui permet au ramasse-miette de nettoyer l'objet au cas où il n'y aurait pas d'autres références vers cet objet.

Étant donné que les références sont faibles, il est impossible d'énumérer les clés des objetsWeakMap (c'est-à-dire qu'on ne dispose pas d'une méthode renvoyant la liste des clés). Si c'était le cas, la liste dépendrait d'un état lié au ramasse-miette et il n'y aurait pas de façon déterministe de connaître le résultat. Si vous souhaitez avoir une liste de clés, vous devriez plutôt utiliser un objetMap.

Constructeur

WeakMap()

Crée un nouvel objetWeakMap.

Méthodes des instances

WeakMap.prototype.delete(<var>key</var>)

Supprime toute valeur associée avec la clékey.WeakMap.prototype.has(key) renverrafalse après coup.

WeakMap.prototype.get(<var>key</var>)

Renvoie la valeur associée à la clékey, ouundefined si cette clé n'est pas présente.

WeakMap.prototype.has(<var>key</var>)

Renvoie un booléen indiquant s'il existe une valeur pour la clékey au sein de l'objetWeakMap.

WeakMap.prototype.set(<var>key</var>, <var>value</var>)

Définit la valeur pour la clékey dans l'objetWeakMap. La valeur de retour est l'objetWeakMap.

Exemples

UtiliserWeakMap

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); // une valeur peut être n'importe quoi, y compris un objet ou une fonctionwm2.set(o3, undefined);wm2.set(wm1, wm2); // Les clés et les valeurs peuvent n'importe quels objets, y compris des WeakMapwm1.get(o2); // "azerty"wm2.get(o2); // undefined car il n'y a pas de valeur pour o2 sur wm2wm2.get(o3); // undefined car c'est la valeur utiliséewm1.has(o2); // truewm2.has(o2); // falsewm2.has(o3); // true (même si la valeur est 'undefined')wm3.set(o1, 37);wm3.get(o1); // 37wm1.has(o1); // truewm1.delete(o1);wm1.has(o1); // false

Implémenter une classe semblable àWeakMap avec une méthode .clear()

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;  }}

Spécifications

Compatibilité des navigateurs

Voir aussi

• Une prothèse (polyfill) deWeakMap est disponible danscore-js
• Le guide sur les collections à clé JavaScript
• Masquer des détails d'implémentation avec les WeakMaps ECMAScript 2015 (en anglais)
• Map
• Set
• WeakSet