peach a19a732be8 commit message 2 years ago
..
.github a19a732be8 commit message 2 years ago
test a19a732be8 commit message 2 years ago
.eslintignore a19a732be8 commit message 2 years ago
.eslintrc a19a732be8 commit message 2 years ago
.nycrc a19a732be8 commit message 2 years ago
CHANGELOG.md a19a732be8 commit message 2 years ago
LICENSE a19a732be8 commit message 2 years ago
README.md a19a732be8 commit message 2 years ago
getInferredName.js a19a732be8 commit message 2 years ago
index.js a19a732be8 commit message 2 years ago
package.json a19a732be8 commit message 2 years ago

README.md

get-symbol-description Version Badge

github actions coverage dependency status dev dependency status License Downloads

npm badge

Gets the description of a Symbol. Handles Symbol() vs Symbol('') properly when possible.

Example

var getSymbolDescription = require('get-symbol-description');
var assert = require('assert');

assert(getSymbolDescription(Symbol()) === undefined);
assert(getSymbolDescription(Symbol('')) === ''); // or `undefined`, if in an engine that lacks name inference from concise method
assert(getSymbolDescription(Symbol('foo')) === 'foo');
assert(getSymbolDescription(Symbol.iterator) === 'Symbol.iterator');

Tests

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