0bc6ae90d58d28ff0ab72cfac65598150bb09f5735f4232d4c449419aa79a494d2bc36d2fb643d9c78c85ecaf0b148a23fab60f83412ebcba44a4d374596b6 1.9 KB

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