CKTIS / JavaScript
WeakMap — Metadaten mit schwach gehaltenen Schlüsseln
WeakMap verknüpft Werte mit Schlüsseln, ohne die Schlüssel selbst am Leben zu halten. Lerne set, get, has und delete, den identitätsbasierten Schlüsselvergleich sowie die Einschränkungen bei Iteration und Garbage Collection kennen.
Version: ECMAScript 2015 (ES2015) introduced WeakMap. ECMAScript 2023 (ES2023) added support for non-registered symbols as keys.
Syntax
const wm = new WeakMap();
wm.set(key, value);
wm.get(key);
wm.has(key);
wm.delete(key);WeakMap speichert Schlüssel-Wert-Zuordnungen. Schlüssel können Objekte oder Symbole außerhalb des globalen Symbolregisters sein, etwa Symbol(), jedoch nicht Symbol.for(). Die Unterstützung solcher Symbole ist Teil von ECMAScript 2023; ältere Engines akzeptieren möglicherweise nur Objekte. Werte können beliebige JavaScript-Werte sein. Objekte werden anhand ihrer Identität verglichen: Zwei separate {}-Objekte sind unterschiedliche Schlüssel.
WeakMap.set bezeichnet hier die Instanzmethode WeakMap.prototype.set, keine statische Methode. wm.set(key, value) fügt einen Wert hinzu oder ersetzt ihn und gibt wm zurück. Ebenso bezeichnet WeakMap.get die Methode WeakMap.prototype.get: wm.get(key) gibt den Wert oder undefined zurück. WeakMap.prototype.has, aufgerufen als wm.has(key), unterscheidet einen fehlenden Eintrag von einem Eintrag mit dem Wert undefined.
WeakMap.delete bezeichnet WeakMap.prototype.delete: wm.delete(key) entfernt den Eintrag und gibt true zurück, wenn er vorhanden war, andernfalls false. Ein ungültiger Schlüsseltyp führt bei set zu einem TypeError; für diesen Schlüssel gibt get undefined zurück, während has und delete false zurückgeben.
Die schwache Verknüpfung verhindert nicht, dass ein Schlüssel bereinigt wird, wenn er ansonsten nicht mehr erreichbar ist. Der Zeitpunkt der Bereinigung ist nicht garantiert; mache die Korrektheit deines Programms nicht davon abhängig. WeakMap bietet weder eine Iteration über Einträge noch size. Verwende es für Metadaten zu Objekten; wenn du Einträge aufzählen musst, wähle Map.
Beispiele
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));Ergebnis
true 7 false true true true false
Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.
Quellen
- 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