Symbol.prototype.description

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

Syntax

Symbol('myDescription').description;
Symbol.iterator.description;
Symbol.for('foo').description;

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

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 Status
https://tc39.github.io/proposal-Symbol-description Stage 3

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support70 No63 No57 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support7070 No6357 No No

See also

Document Tags and Contributors

Contributors to this page: fscholz, LJHarb
Last updated by: fscholz,