Symbol.prototype.description

Свойство доступа description объекта Symbol возвращает строку, содержащую описание этого символа, или undefined, если символ не имеет описания.

Попробуйте

console.log(Symbol("desc").description);
// Expected output: "desc"

console.log(Symbol.iterator.description);
// Expected output: "Symbol.iterator"

console.log(Symbol.for("foo").description);
// Expected output: "foo"

console.log(`${Symbol("foo").description}bar`);
// Expected output: "foobar"

Описание

Объекты Symbol могут быть созданы с необязательным описанием, которое может использоваться для отладки, но не для доступа к самому символу. Свойство Symbol.prototype.description может использоваться для чтения этого описания. Оно отличается от Symbol.prototype.toString() тем, что не содержит обрамляющую строку "Symbol()". См. примеры.

Примеры

Использование описания

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"

Спецификации

Совместимость с браузерами

См. также

• Polyfill of Symbol.prototype.description in core-js
• es-shims polyfill of Symbol.prototype.description
• Symbol.prototype.toString()