CKTIS / JavaScript
WeakMap — métadonnées avec des clés détenues faiblement
WeakMap associe des valeurs à des clés sans maintenir ces clés en vie. Découvrez set, get, has et delete, la comparaison des clés par identité ainsi que les limites concernant l’itération et le ramasse-miettes.
Version : ECMAScript 2015 (ES2015) introduced WeakMap. ECMAScript 2023 (ES2023) added support for non-registered symbols as keys.
Syntaxe
const wm = new WeakMap();
wm.set(key, value);
wm.get(key);
wm.has(key);
wm.delete(key);WeakMap stocke des associations clé-valeur. Les clés peuvent être des objets ou des symboles qui ne figurent pas dans le registre global des symboles, comme Symbol(), mais pas Symbol.for(). La prise en charge de ces symboles fait partie d’ECMAScript 2023 ; les moteurs plus anciens peuvent n’accepter que des objets. Les valeurs peuvent être de n’importe quel type JavaScript. Les objets sont comparés par identité : deux objets {} distincts sont des clés différentes.
WeakMap.set désigne ici la méthode d’instance WeakMap.prototype.set, et non une méthode statique. wm.set(key, value) ajoute ou remplace une valeur et renvoie wm. De même, WeakMap.get désigne WeakMap.prototype.get : wm.get(key) renvoie la valeur ou undefined. WeakMap.prototype.has, appelé sous la forme wm.has(key), permet de distinguer une entrée absente d’une entrée dont la valeur est undefined.
WeakMap.delete désigne WeakMap.prototype.delete : wm.delete(key) supprime l’entrée et renvoie true si elle existait, ou false dans le cas contraire. Un type de clé invalide provoque une TypeError avec set ; pour cette clé, get renvoie undefined, tandis que has et delete renvoient false.
L’association faible n’empêche pas la récupération d’une clé qui n’est plus accessible autrement. Le moment de cette récupération n’est pas garanti ; ne faites pas dépendre la correction de votre programme de ce comportement. WeakMap ne permet ni de parcourir les entrées ni d’accéder à size. Utilisez-le pour les métadonnées associées aux objets ; choisissez Map si vous devez énumérer les entrées.
Exemples
const metadata = new WeakMap();
const key = {};
const other = {};
console.log(metadata.set(key, 7) === metadata);
console.log(metadata.get(key));
console.log(metadata.has(other));
metadata.set(key, undefined);
console.log(metadata.has(key));
console.log(metadata.get(key) === undefined);
console.log(metadata.delete(key));
console.log(metadata.delete(key));Résultat
true 7 false true true true false
Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.
Sources
- ECMAScript® Language Specification
- ECMAScript® Language Specification — Keyed Collections
- ECMAScript® 2023 Language Specification — Executable Code and Execution Contexts
- Official reference — tc39.es: ecma262
- Official reference — tc39.es: ecma262
- Official reference — tc39.es: ecma262
- Official reference — developer.mozilla.org: WeakMap / has