81a48980e16f01e04b6650f3f19a2d13de69c6a97ec96745eee201d8bbe0b43a973aa35a1988d5b94d33bfae25dba995f9b341dbdb27acce15fd5f53847c73 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. # is-map <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 value a JS Map? This module works cross-realm/iframe, and despite ES6 @@toStringTag.
  10. ## Example
  11. ```js
  12. var isMap = require('is-map');
  13. assert(!isMap(function () {}));
  14. assert(!isMap(null));
  15. assert(!isMap(function* () { yield 42; return Infinity; });
  16. assert(!isMap(Symbol('foo')));
  17. assert(!isMap(1n));
  18. assert(!isMap(Object(1n)));
  19. assert(!isMap(new Set()));
  20. assert(!isMap(new WeakSet()));
  21. assert(!isMap(new WeakMap()));
  22. assert(isMap(new Map()));
  23. class MyMap extends Map {}
  24. assert(isMap(new MyMap()));
  25. ```
  26. ## Tests
  27. Simply clone the repo, `npm install`, and run `npm test`
  28. [1]: https://npmjs.org/package/is-map
  29. [2]: https://versionbadg.es/inspect-js/is-map.svg
  30. [5]: https://david-dm.org/inspect-js/is-map.svg
  31. [6]: https://david-dm.org/inspect-js/is-map
  32. [7]: https://david-dm.org/inspect-js/is-map/dev-status.svg
  33. [8]: https://david-dm.org/inspect-js/is-map#info=devDependencies
  34. [11]: https://nodei.co/npm/is-map.png?downloads=true&stars=true
  35. [license-image]: https://img.shields.io/npm/l/is-map.svg
  36. [license-url]: LICENSE
  37. [downloads-image]: https://img.shields.io/npm/dm/is-map.svg
  38. [downloads-url]: https://npm-stat.com/charts.html?package=is-map
  39. [codecov-image]: https://codecov.io/gh/inspect-js/is-map/branch/main/graphs/badge.svg
  40. [codecov-url]: https://app.codecov.io/gh/inspect-js/is-map/
  41. [actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/is-map
  42. [actions-url]: https://github.com/inspect-js/is-map/actions