Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

WeakMap: ler, escrever e eliminar entradas

Aprende o que devolvem `get`, `set` e `delete`, que chaves são aceites e como distinguir uma entrada inexistente de outra cujo valor é `undefined`.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

const wm = new WeakMap();
wm.get(key);
wm.set(key, value);
wm.delete(key);

get, set e delete são três métodos de WeakMap.prototype. Chama-os numa instância de WeakMap, como em wm.get(key), e não como métodos estáticos do construtor. Uma chamada sem uma instância adequada ou com um valor de this incompatível lança um TypeError.

wm.get(key) devolve o valor guardado ou undefined se a chave estiver ausente ou for inválida. Usa wm.has(key) para distinguir uma entrada inexistente de um valor undefined guardado. wm.set(key, value) acrescenta uma entrada ou substitui o seu valor. Aceita qualquer valor e devolve a mesma instância, o que permite encadear chamadas. wm.delete(key) devolve true se removeu uma entrada e false se a chave estiver ausente ou for inválida. O método remove uma entrada, não uma propriedade de um objeto como faz o operador delete.

O ECMAScript 2024 permite usar como chaves objetos, incluindo funções, e símbolos não registados, como os criados por Symbol(). Os símbolos registados através de Symbol.for() e os restantes valores primitivos não são chaves válidas; nesses casos, set lança um TypeError. As chaves são comparadas por identidade: dois objetos distintos com as mesmas propriedades são chaves diferentes. Confirma se o ambiente de execução de destino suporta chaves do tipo símbolo.

Usa uma WeakMap para associar metadados a um objeto sem o manter vivo apenas por servir de chave. A coleção não mantém referências fortes às suas chaves. Não há garantias sobre quando a memória será recuperada e as chaves não podem ser enumeradas. Usa uma Map se precisares de percorrer as chaves.

Exemplos

{
  const metadata = new WeakMap();
  const item = { id: 1 };

  console.log(metadata.set(item, 1) === metadata);
  metadata.set(item, 2);
  console.log(metadata.get(item));
  console.log(metadata.get({ id: 1 }));

  metadata.set(item, undefined);
  console.log(metadata.get(item) === undefined && metadata.has(item));
  console.log(metadata.delete(item));
  console.log(metadata.delete(item));
  console.log(metadata.get(item));
}

Resultado

true
2
undefined
true
true
false
undefined

`set` devolve a mesma coleção e substitui `1` por `2`. O novo objeto `{ id: 1 }` é uma chave diferente. `has` confirma a presença da entrada com `undefined`; só a primeira chamada a `delete` a remove.

Lições relacionadas

  • JavaScript · Lição 3 · Avançado · Versão: 4
  • JavaScript · Lição 7 · Avançado · Versão: 4
  • JavaScript · Lição 41 · Intermédio · Versão: 3

Fontes