The read-only description property is a string returning the optional description of Symbol objects.


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.


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"


ECMAScript (ECMA-262)
The definition of 'get Symbol.prototype.description' in that specification.

Browser compatibility

Update compatibility data on GitHub
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung InternetNode.js
descriptionChrome Full support 70Edge Full support 79Firefox Full support 63IE No support NoOpera Full support 57Safari Full support 12.1
Full support 12.1
Partial support 12
Notes No support for an undefined description.
WebView Android Full support 70Chrome Android Full support 70Firefox Android Full support 63Opera Android Full support 49Safari iOS Full support 12.2
Full support 12.2
Partial support 12
Notes No support for an undefined description.
Samsung Internet Android Full support 10.0nodejs Full support 11.0.0


Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

See also