| 12345678910111213141516171819202122232425262728293031323334353637383940414243 |
- # get-symbol-description <sup>[![Version Badge][2]][1]</sup>
- [![github actions][actions-image]][actions-url]
- [![coverage][codecov-image]][codecov-url]
- [![dependency status][5]][6]
- [![dev dependency status][7]][8]
- [![License][license-image]][license-url]
- [![Downloads][downloads-image]][downloads-url]
- [![npm badge][11]][1]
- Gets the description of a Symbol. Handles `Symbol()` vs `Symbol('')` properly when possible.
- ## Example
- ```js
- 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`
- [1]: https://npmjs.org/package/get-symbol-description
- [2]: https://versionbadg.es/inspect-js/get-symbol-description.svg
- [5]: https://david-dm.org/inspect-js/get-symbol-description.svg
- [6]: https://david-dm.org/inspect-js/get-symbol-description
- [7]: https://david-dm.org/inspect-js/get-symbol-description/dev-status.svg
- [8]: https://david-dm.org/inspect-js/get-symbol-description#info=devDependencies
- [11]: https://nodei.co/npm/get-symbol-description.png?downloads=true&stars=true
- [license-image]: https://img.shields.io/npm/l/get-symbol-description.svg
- [license-url]: LICENSE
- [downloads-image]: https://img.shields.io/npm/dm/get-symbol-description.svg
- [downloads-url]: https://npm-stat.com/charts.html?package=get-symbol-description
- [codecov-image]: https://codecov.io/gh/inspect-js/get-symbol-description/branch/main/graphs/badge.svg
- [codecov-url]: https://app.codecov.io/gh/inspect-js/get-symbol-description/
- [actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/get-symbol-description
- [actions-url]: https://github.com/inspect-js/get-symbol-description/actions
|
