WeakMap

L'objet WeakMap 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.

Syntaxe

new WeakMap([itérable])

Paramètres

itérable
Paramètre optionnel. Un tableau (objet Array) ou tout autre objet itérable dont les éléments sont des paires composées d'une clé et d'une valeur (des tableaux de 2 éléments). Chaque paire sera ajoutée à la carte (map en anglais). null sera traité comme undefined.

Description

Les clés des objets WeakMap sont nécessairement du type Object. Des types de données primitifs ne sont pas autorisés pour les clés (ex : un Symbol ne peut pas être une clé dans un WeakMap).

Les clés d'une WeakMap sont référencées faiblement. 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 la WeakMap 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. Le premier est que la recherche serait effectué en O(n) (avec n le nombre de clés). 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êcheraient d'être nettoyés par le ramasse-miette. Grâce aux objets natifs WeakMaps, 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 objets WeakMap (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. Aussi, si vous souhaitez avoir une liste de clés, vous devez la maintenir vous-même. (Voir également Map)

Propriétés

WeakMap.length
La valeur de la propriété length vaut 0.
WeakMap.prototype
Cette propriété représente le prototype du constructeur WeakMap. Il permet d'ajouter des propriétés pour toutes les instances de WeakMap.

Instances de WeakMap

Toutes les instances de WeakMap héritent de WeakMap.prototype.

Propriétés

Méthodes

Exemple

Utiliser 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); // une valeur peut être n'importe quoi, y compris un objet ou une fonction
wm2.set(o3, undefined);
wm2.set(wm1, wm2); // Les clés et les valeurs peuvent n'importe quels objets, y compris des WeakMap

wm1.get(o2); // "azerty"
wm2.get(o2); // undefined car il n'y a pas de valeur pour o2 sur wm2
wm2.get(o3); // undefined car c'est la valeur utilisée

wm1.has(o2); // true
wm2.has(o2); // false
wm2.has(o3); // true (même si la valeur est 'undefined')

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

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

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

À des fins d'illustrations, on utilise la nouvelle construction ECMAScript 6 class, qui n'est pas encore largement implémentée.

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

Spécification État Commentaires
ECMAScript 2015 (6th Edition, ECMA-262)
La définition de 'WeakMap' dans cette spécification.
Standard Définition initiale.
ECMAScript 2017 Draft (ECMA-262)
La définition de 'WeakMap' dans cette spécification.
Projet  

Compatibilité des navigateurs

Fonctionnalité Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari
Support simple 36 12 6.0 (6.0) 11 23 7.1
new WeakMap(iterable) 38 12 36 (36) Pas de support 25 Pas de support
Retrait de la méthode clear() method obsolète 43 12 46 (46) Pas de support 30 9
Argument du constructeur: new WeakMap(null) (Oui) 12 37 (37) 11 ? ?
set() corrigé (monkey patched) pour le constructeur (Oui) 12 37 (37) ? ? ?
WeakMap() sans  new lève une exception (Oui) 12 42 (42) 11 ? ?
Fonctionnalité Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Support simple 35 6.0 (6.0) Pas de support Pas de support 8
new WeakMap(iterable) 38 36.0 (36) Pas de support Pas de support Pas de support
Retrait de la méthode clear() method obsolète 43 ? ? 30 9
Argument du constructeur: new WeakMap(null) ? 37.0 (37) Pas de support ? ?
set() corrigé (monkey patched) pour le constructeur ? 37.0 (37) Pas de support ? ?
WeakMap() sans  new lève une exception ? 42.0 (42) ? ? ?

[1] La méthode clear() a été supporté depuis la version 20 et jusqu'à la version 45 (incluse)

Voir aussi

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : SphinxKnight, Spotinux
 Dernière mise à jour par : SphinxKnight,