CKTIS / JavaScript
WeakMap — metadados com chaves mantidas fracamente
WeakMap associa valores a chaves sem manter as próprias chaves vivas. Aprende a usar set, get, has e delete, a comparação de chaves por identidade e as limitações relativas à iteração e à recolha de lixo.
Versão: ECMAScript 2015 (ES2015) introduced WeakMap. ECMAScript 2023 (ES2023) added support for non-registered symbols as keys.
Sintaxe
const wm = new WeakMap();
wm.set(key, value);
wm.get(key);
wm.has(key);
wm.delete(key);WeakMap armazena associações entre chaves e valores. As chaves podem ser objetos ou símbolos que não pertençam ao registo global de símbolos, como Symbol(), mas não Symbol.for(). O suporte para estes símbolos faz parte do ECMAScript 2023; os motores mais antigos podem aceitar apenas objetos. Os valores podem ser de qualquer tipo JavaScript. Os objetos são comparados por identidade: dois objetos {} distintos são chaves diferentes.
WeakMap.set refere-se aqui ao método de instância WeakMap.prototype.set, e não a um método estático. wm.set(key, value) adiciona ou substitui um valor e devolve wm. Do mesmo modo, WeakMap.get refere-se a WeakMap.prototype.get: wm.get(key) devolve o valor ou undefined. WeakMap.prototype.has, chamado como wm.has(key), distingue uma entrada inexistente de uma entrada cujo valor é undefined.
WeakMap.delete refere-se a WeakMap.prototype.delete: wm.delete(key) remove a entrada e devolve true se ela existia, ou false caso contrário. Um tipo de chave inválido provoca um TypeError em set; para essa chave, get devolve undefined, enquanto has e delete devolvem false.
A associação fraca não impede a recolha de uma chave que já não seja alcançável por outros meios. O momento da recolha não é garantido; não faças depender disso a correção do programa. WeakMap não permite iterar pelas entradas nem disponibiliza size. Usa-o para metadados associados a objetos; escolhe Map se precisares de enumerar as entradas.
Exemplos
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
O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.
Fontes
- 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