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 (eg, node >= v11.15.0)

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');
var assert = require('assert');

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

if (!('description' in Symbol.prototype)) {
	// 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);

	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.6 - 2024-02-15

Commits

• [actions] reuse common workflows 92fa371
• [Fix] behave properly in a pre-Symbol environment d61003b
• [meta] use npmignore to autogenerate an npmignore file 7ba5498
• [Dev Deps] update eslint, @ljharb/eslint-config, @es-shims/api, safe-publish-latest, tape b49e7eb
• [Dev Deps] update eslint, @ljharb/eslint-config, aud, auto-changelog, reflect.ownkeys, tape e6351a6
• [Dev Deps] update @es-shims/api, @ljharb/eslint-config, aud ,npmignore, reflect.ownkeys, tape 409cc9b
• [actions] update rebase action to use reusable workflow 5059d72
• [actions] update codecov uploader 1e98508
• [Dev Deps] update @es-shims/api, @ljharb/eslint-config, aud, reflect.ownkeys, tape 67b55d3
• [Deps] update call-bind, get-symbol-description, object.getownpropertydescriptors 19c078d
• [readme] add github actions/codecov badges 79fa955
• [Dev Deps] update @ljharb/eslint-config, @es-shims/api, reflect.ownkeys cd0fa9d
• [Deps] update has-symbol, object.getownpropertydescriptors 462aace
• [actions] update workflows 75f45ff
• [Deps] update object.getownpropertydescriptors 643f896
• [Deps] update object.getownpropertydescriptors c6b9eba