44ed7fcb95914c2bcb37f22715ceaea914506b25e4e2af359df7eddfca50b554783fa624495045e984855af8dd8b7a118096af3600e77081a28613080b1285 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. # is-symbol <sup>[![Version Badge][2]][1]</sup>
  2. [![github actions][actions-image]][actions-url]
  3. [![coverage][codecov-image]][codecov-url]
  4. [![dependency status][5]][6]
  5. [![dev dependency status][7]][8]
  6. [![License][license-image]][license-url]
  7. [![Downloads][downloads-image]][downloads-url]
  8. [![npm badge][11]][1]
  9. Is this an ES6 Symbol value?
  10. ## Example
  11. ```js
  12. var isSymbol = require('is-symbol');
  13. assert(!isSymbol(function () {}));
  14. assert(!isSymbol(null));
  15. assert(!isSymbol(function* () { yield 42; return Infinity; });
  16. assert(isSymbol(Symbol.iterator));
  17. assert(isSymbol(Symbol('foo')));
  18. assert(isSymbol(Symbol.for('foo')));
  19. assert(isSymbol(Object(Symbol('foo'))));
  20. ```
  21. ## Tests
  22. Simply clone the repo, `npm install`, and run `npm test`
  23. [1]: https://npmjs.org/package/is-symbol
  24. [2]: https://versionbadg.es/inspect-js/is-symbol.svg
  25. [5]: https://david-dm.org/inspect-js/is-symbol.svg
  26. [6]: https://david-dm.org/inspect-js/is-symbol
  27. [7]: https://david-dm.org/inspect-js/is-symbol/dev-status.svg
  28. [8]: https://david-dm.org/inspect-js/is-symbol#info=devDependencies
  29. [11]: https://nodei.co/npm/is-symbol.png?downloads=true&stars=true
  30. [license-image]: https://img.shields.io/npm/l/is-symbol.svg
  31. [license-url]: LICENSE
  32. [downloads-image]: https://img.shields.io/npm/dm/is-symbol.svg
  33. [downloads-url]: https://npm-stat.com/charts.html?package=is-symbol
  34. [codecov-image]: https://codecov.io/gh/inspect-js/is-symbol/branch/main/graphs/badge.svg
  35. [codecov-url]: https://app.codecov.io/gh/inspect-js/is-symbol/
  36. [actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/is-symbol
  37. [actions-url]: https://github.com/inspect-js/is-symbol/actions