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

CKTIS / JavaScript

Symbol.for() — símbolos de um registo partilhado

Symbol.for(key) procura um símbolo no registo global através de uma chave de texto. Devolve o símbolo existente ou cria e regista um novo. Assim, partes de código independentes podem obter a mesma chave de propriedade simbólica.

Versão: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxe

Symbol.for(key)

Symbol.for(key) é um método estático que devolve um valor primitivo do tipo symbol. Procura a chave de texto fornecida no registo global de símbolos do ambiente de execução. Se a chave não existir, cria um símbolo e regista-o com essa chave. A chave também serve de descrição do símbolo.

Ao contrário de Symbol.for("cktis.status"), cada chamada a Symbol("cktis.status") cria um símbolo distinto: descrições idênticas não implicam uma identidade idêntica. O registo permite partilhar símbolos entre ficheiros e entre realms que partilham o registo. Não é um mecanismo de armazenamento persistente de dados.

Utilize prefixos como cktis.status para reduzir colisões de nomes com bibliotecas. Um símbolo registado não é um segredo: outro código que conheça a chave pode obtê-lo. Symbol.keyFor(symbol) devolve a chave de um símbolo registado, mas devolve undefined para um símbolo criado com Symbol().

O exemplo lê uma propriedade de um objeto através de um símbolo novamente obtido do registo. A MDN indica que Symbol.for() está disponível nos browsers desde setembro de 2015; não é uma API exclusiva dos browsers.

Exemplos

const first = Symbol.for("cktis.status");
const second = Symbol.for("cktis.status");
const local = Symbol("cktis.status");
const record = { [first]: "ready" };

console.log(first === second);
console.log(first === local);
console.log(record[second]);
console.log(Symbol.keyFor(first));
console.log(Symbol.keyFor(local));

Resultado

true
false
ready
cktis.status
undefined

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