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

CKTIS / JavaScript

WeakMap.prototype.set(): associar um valor a uma chave

`set()` adiciona uma entrada a um `WeakMap` ou substitui o valor de uma chave existente. Devolve a mesma instância, o que permite encadear chamadas.

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

Sintaxe

weakMap.set(key, value)

WeakMap.prototype.set é um método do protótipo que se chama numa instância: weakMap.set(key, value). Adiciona uma entrada para uma chave nova ou substitui o valor associado à mesma chave. Devolve a mesma instância, e não o valor guardado, pelo que é possível encadear outra chamada a .set(). O valor pode ser qualquer valor de JavaScript, incluindo undefined.

As chaves que são objetos são comparadas por identidade: dois objetos distintos com propriedades idênticas são chaves diferentes. O ECMAScript 2024 também permite símbolos não registados, como Symbol("id"). Os símbolos obtidos com Symbol.for("id") e outros valores primitivos, como cadeias de caracteres, não são chaves válidas. Ambientes de execução mais antigos podem não aceitar chaves do tipo símbolo; verifica o ambiente de destino.

Uma chave inválida lança um TypeError. Chamar o método separado da instância sem o this correto também lança um TypeError: o recetor tem de ser uma instância de WeakMap.

A entrada, por si só, não mantém a chave viva. Se a chave deixar de estar acessível por outras vias, pode ser removida pelo mecanismo de gestão automática de memória; não dependas do momento em que isso acontece. Não é possível enumerar as chaves de um WeakMap. Se precisares de percorrer as chaves ou de usar cadeias de caracteres como chaves, usa antes um Map.

Exemplos

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

  metadata.set(item, 10);
  console.log(metadata.get(item));

  const returned = metadata.set(item, 20);
  console.log(returned === metadata);
  console.log(metadata.get(item));
  console.log(metadata.has({ id: 1 }));

  try {
    metadata.set("id", 30);
  } catch (error) {
    console.log(error instanceof TypeError);
  }
}

Resultado

10
true
20
false
true

A primeira consulta devolve `10`; após a atualização, devolve `20`. A comparação `returned === metadata` dá `true`. Um novo objeto com o mesmo `id` não é a chave guardada, pelo que `has()` devolve `false`. A tentativa de usar uma cadeia de caracteres como chave lança um `TypeError`, que é capturado.

Lições relacionadas

  • JavaScript · Lição 35 · Básico · Versão: 4
  • JavaScript · Lição 37 · Básico · Versão: 4
  • JavaScript · Lição 4 · Intermédio · Versão: 3
  • JavaScript · Lição 10 · Intermédio · Versão: 3

Fontes