Symbol.toStringTag 是一个内置的 Symbol 值,用于自定义对象在调用 Object.prototype.toString() 时返回的类名标签,同时能影响调试器中的类型显示。开发者可直接赋值、通过原型或类 getter 定义,甚至利用 Proxy 实现动态标签,且不影响 instanceof 或 typeof 的判断。
Symbol.toStringTag 是一个内置 symbol,用于指定对象在调用 Object.prototype.toString() 时返回字符串中的类名部分(即方括号内的名称)。它对调试器(如 Chrome DevTools、VS Code 调试面板)中对象的显示标签有直接影响——许多现代调试器会读取该属性,将其作为对象的“类型标识”展示在变量面板或控制台中。
只需在对象上定义一个 toStringTag 属性,值为字符串即可。该属性需是可枚举的(默认不可枚举),但调试器通常仍能读取(因其通过内部协议访问,不依赖 for...in 或 Object.keys)。
obj[Symbol.toStringTag] = 'MyType'
例如:
class Point {
constructor(x, y) { this.x = x; this.y = y; }
get [Symbol.toStringTag]() { return 'Point'; }
}
const p = new Point(1, 2);
console.log(p.toString()); // "[object Point]"
// 在 Chrome 控制台打印 p,左侧会显示 "Point" 标签
注意:不能直接给原始值(如字符串字面量、数字)设置 toStringTag,因为它们不是对象。但可以给其包装对象(如 new String('hello'))设置:
const s = new String('hello'); s[Symbol.toStringTag] = 'CustomStr'; console.log(s.toString()); // "[object CustomStr]"若需根据状态动态改变调试显示名,可用 Proxy 拦截 get,让 [Symbol.toStringTag] 返回计算后的字符串:
const createLabeledArray = (label) =>
new Proxy([], {
get(target, prop) {
if (prop === Symbol.toStringTag) return label;
return Reflect.get(target, prop);
}
});
const todos = createLabeledArray('TodoList');
console.log(todos.toString()); // "[object TodoList]"
// DevTools 中展开该数组,顶部会显示 "TodoList"