Symbol.prototype.description
The read-only description
property is a string returning the optional description of Symbol
objects.
Description
Symbol
objects can be created with an optional description which can be used for debugging but not to access the symbol itself. The Symbol.prototype.description
property can be used to read that description. It is different to Symbol.prototype.toString()
as it does not contain the enclosing "Symbol()
" string. See the examples.
Examples
Using description
Symbol('desc').toString(); // "Symbol(desc)"
Symbol('desc').description; // "desc"
Symbol('').description; // ""
Symbol().description; // undefined
// well-known symbols
Symbol.iterator.toString(); // "Symbol(Symbol.iterator)"
Symbol.iterator.description; // "Symbol.iterator"
// global symbols
Symbol.for('foo').toString(); // "Symbol(foo)"
Symbol.for('foo').description; // "foo"
Specifications
Specification |
---|
ECMAScript Language Specification # sec-symbol.prototype.description |
Browser compatibility
BCD tables only load in the browser