Symbol.toStringTag

Symbol.toStringTag 内置通用（well-known）symbol 是一个字符串值属性，用于创建对象的默认字符串描述。它由 Object.prototype.toString() 方法内部访问。

尝试一下

Symbol.toStringTag 的属性特性
可写 否
可枚举 否
可配置 否

示例

默认标签

一些值没有 Symbol.toStringTag，但是有额外的 toString() 表示。有关完整列表，请参见 Object.prototype.toString()。

js
Object.prototype.toString.call("foo"); // "[object String]"
Object.prototype.toString.call([1, 2]); // "[object Array]"
Object.prototype.toString.call(3); // "[object Number]"
Object.prototype.toString.call(true); // "[object Boolean]"
Object.prototype.toString.call(undefined); // "[object Undefined]"
Object.prototype.toString.call(null); // "[object Null]"
// ... and more

内置的 toStringTag symbol

大多数内置的对象提供了它们自己的 @@toStringTag 属性。所有内置对象的 @@toStringTag 属性都是不可写的（writable）、不可枚举的（enumerable）但是可配置的（configurable）。

js
Object.prototype.toString.call(new Map()); // "[object Map]"
Object.prototype.toString.call(function* () {}); // "[object GeneratorFunction]"
Object.prototype.toString.call(Promise.resolve()); // "[object Promise]"
// ... and more

使用 toStringTag 自定义标签

当创建你自己的类时，JavaScript 默认用“Object”标签：

js
class ValidatorClass {}

Object.prototype.toString.call(new ValidatorClass()); // "[object Object]"

现在，在 toStringTag 的帮助下，你可以设置自己的自定义标签：

js
class ValidatorClass {
  get [Symbol.toStringTag]() {
    return "Validator";
  }
}

Object.prototype.toString.call(new ValidatorClass()); // "[object Validator]"

toStringTag 适用于所有 DOM 原型对象

由于 2020 年年中 WebIDL 规范的变化，浏览器正在向所有 DOM 原型对象添加 Symbol.toStringTag 属性。例如，要访问 HTMLButtonElement 上的 Symbol.toStringTag 属性：

js
const test = document.createElement("button");
test.toString(); // Returns [object HTMLButtonElement]
test[Symbol.toStringTag]; // Returns HTMLButtonElement

规范

Specification
ECMAScript Language Specification
# sec-symbol.tostringtag

浏览器兼容性

BCD tables only load in the browser

参见