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

CKTIS / JavaScript

Symbol.toStringTag — uma etiqueta personalizada do objeto

Symbol.toStringTag é um símbolo conhecido usado como chave de propriedade para fornecer a etiqueta apresentada no resultado de Object.prototype.toString(). Altera a descrição de um objeto, não o seu tipo real.

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

const value = { [Symbol.toStringTag]: "Widget" };
Object.prototype.toString.call(value);

Symbol.toStringTag é um símbolo conhecido, não um método. Uma propriedade do objeto com esta chave pode fornecer a cadeia de caracteres que Object.prototype.toString.call(value) utiliza para produzir um resultado como [object Widget]. A chave de símbolo não é o mesmo que a chave de cadeia de caracteres "Symbol.toStringTag".

O método também lê esta propriedade ao longo da cadeia de protótipos. Se o valor não for uma cadeia de caracteres, utiliza a etiqueta predefinida, como Object para um objeto comum; não converte o valor numa cadeia de caracteres. Um getter pode ser executado, e qualquer exceção que lance é propagada.

A etiqueta é descritiva, não é uma verificação fiável do tipo: pode ser falsificada. Não altera typeof, o protótipo nem as capacidades internas do objeto. Também não substitui um método toString() personalizado nem controla, em geral, a conversão para um valor primitivo — essa é a função de Symbol.toPrimitive.

Exemplos

const item = { [Symbol.toStringTag]: "Widget" };
console.log(Object.prototype.toString.call(item));

item[Symbol.toStringTag] = 42;
console.log(Object.prototype.toString.call(item));
console.log(typeof item);

Resultado

[object Widget]
[object Object]
object

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