CKTIS / JavaScript
WeakMap — metadatos con claves débilmente retenidas
WeakMap asocia valores a claves sin mantener vivas las propias claves. Aprende a usar set, get, has y delete, la comparación de claves por identidad y las limitaciones relativas a la iteración y a la recolección de basura.
Versión: ECMAScript 2015 (ES2015) introduced WeakMap. ECMAScript 2023 (ES2023) added support for non-registered symbols as keys.
Sintaxis
const wm = new WeakMap();
wm.set(key, value);
wm.get(key);
wm.has(key);
wm.delete(key);WeakMap almacena asociaciones entre claves y valores. Las claves pueden ser objetos o símbolos que no estén en el registro global de símbolos, como Symbol(), pero no Symbol.for(). La compatibilidad con estos símbolos forma parte de ECMAScript 2023; los motores más antiguos quizá solo acepten objetos. Los valores pueden ser de cualquier tipo de JavaScript. Los objetos se comparan por identidad: dos objetos {} distintos son claves diferentes.
WeakMap.set se refiere aquí al método de instancia WeakMap.prototype.set, no a un método estático. wm.set(key, value) añade o sustituye un valor y devuelve wm. Del mismo modo, WeakMap.get se refiere a WeakMap.prototype.get: wm.get(key) devuelve el valor o undefined. WeakMap.prototype.has, llamado como wm.has(key), distingue entre una entrada inexistente y una entrada cuyo valor es undefined.
WeakMap.delete se refiere a WeakMap.prototype.delete: wm.delete(key) elimina la entrada y devuelve true si existía, o false en caso contrario. Un tipo de clave no válido provoca un TypeError en set; para esa clave, get devuelve undefined, mientras que has y delete devuelven false.
La asociación débil no impide que se recoja una clave que ya no sea accesible por otros medios. El momento de la recolección no está garantizado; no hagas depender de ello la corrección del programa. WeakMap no permite iterar por las entradas ni ofrece size. Úsalo para metadatos asociados a objetos; elige Map cuando necesites enumerar las entradas.
Ejemplos
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));Resultado
true 7 false true true true false
El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.
Fuentes
- 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