symbol.prototype.description

Symbol.prototype.description

An ECMAScript spec-compliant Symbol.prototype.description shim. Invoke its "shim" method to shim Symbol.prototype.description if it is unavailable. Note: Symbol#description requires a true ES6 environment, specifically one with native Symbols.

This package implements the es-shim API interface. It works in an ES6-supported environment and complies with the spec.

Most common usage:

var description = require('symbol.prototype.description');

assert(description(Symbol('foo')) === 'foo');
assert(description(Symbol()) === undefined);
assert(description(Symbol(undefined)) === undefined);
assert(description(Symbol(null)) === 'null');

// note: this should be the empty string, but in many engines,
// it is impossible to distinguish Symbol() and Symbol('')
// without globally replacing `Symbol`
assert(description(Symbol('')) === undefined);

if (!Symbol.prototype.description) {
	description.shim();
}

assert(description(Symbol('foo')) === Symbol('foo').description);
assert(description(Symbol()) === Symbol().description);
assert(description(Symbol(undefined)) === Symbol(undefined).description);
assert(description(Symbol(null)) === Symbol(null).description);

assert(Symbol('').description === ''); // this works fine!

Tests

Simply clone the repo, npm install, and run npm test

Changelog

v1.0.5 - 2021-08-17

Commits

• [actions] use node/install instead of node/run; use codecov action 071b81c
• [Refactor] use get-symbol-description, extracted from es-abstract 158e940
• [Dev Deps] update eslint, @ljharb/eslint-config, aud, auto-changelog, tape 8ba38ec
• [actions] restore 0.x test config, from 071b81c d0562a9
• [Deps] update es-abstract, has-symbols 4be56f3
• [Dev Deps] update eslint, tape 184c012
• [meta] use prepublishOnly script for npm 7+ e93c72f
• [meta] add sideEffects flag 57faa96