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

CKTIS / JavaScript

WeakMap: verificar, ler e escrever entradas com has(), get() e set()

Verifica se uma chave existe, lê o seu valor ou atualiza-o. Aprende a distinguir uma entrada ausente de um `undefined` guardado e a reconhecer as chaves válidas.

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

Sintaxe

weakMap.has(key)
weakMap.get(key)
weakMap.set(key, value)

WeakMap.prototype.has/get/set é uma abreviatura para três métodos de instância de WeakMap. As chaves são comparadas pela sua identidade: dois objetos distintos com propriedades idênticas são chaves diferentes.

  • has(key) devolve true se existir uma entrada e false caso contrário.
  • get(key) devolve o valor guardado ou undefined se não existir uma entrada. Usa has(key) para distinguir uma entrada ausente de um undefined guardado.
  • set(key, value) acrescenta uma entrada ou substitui o valor associado à mesma chave. Aceita qualquer valor JavaScript e devolve a mesma instância de WeakMap, o que permite encadear chamadas.

O ECMAScript 2024 aceita objetos (incluindo funções) e símbolos não registados como chaves, por exemplo Symbol() e Symbol.iterator, mas não símbolos obtidos com Symbol.for(). Os ambientes de execução mais antigos podem aceitar apenas objetos como chaves; verifica se o ambiente de destino aceita chaves do tipo símbolo.

Para uma chave inválida como 1, has() devolve false, get() devolve undefined e set() lança um TypeError. Os três métodos verificam primeiro this: se não for uma instância genuína de WeakMap, a chamada lança um TypeError independentemente da chave.

Usa WeakMap para associar metadados a um objeto sem manter a chave viva, mesmo que o valor guardado faça referência à chave. Não há garantias sobre quando a memória será libertada. WeakMap não permite percorrer as chaves nem disponibiliza size; usa Map se precisares dessas funcionalidades ou de chaves que sejam cadeias de caracteres ou números.

Exemplos

{
  const map = new WeakMap();
  const key = { id: 1 };
  const lookalike = { id: 1 };

  map.set(key, undefined);
  console.log(`stored: ${map.has(key)}, ${map.get(key)}`);
  console.log(`missing: ${map.has(lookalike)}, ${map.get(lookalike)}`);

  const result = map.set(key, 42);
  console.log(`updated: ${map.get(key)}, same map: ${result === map}`);

  console.log(`invalid key: ${map.has(1)}, ${map.get(1)}`);
  try {
    map.set(1, 42);
  } catch (error) {
    console.log(error.name);
  }
}

Resultado

stored: true, undefined
missing: false, undefined
updated: 42, same map: true
invalid key: false, undefined
TypeError

`key` e `lookalike` têm o mesmo `id`, mas são objetos distintos. As duas leituras devolvem inicialmente `undefined`; só `has(key)` devolve `true`. A segunda escrita substitui o valor por `42` e devolve o mesmo mapa. A chave `1` mostra a diferença entre ler e escrever com uma chave inválida.

Lições relacionadas

  • JavaScript · Lição 17 · Avançado · Versão: 4

Fontes