1b3b24bff685d7beccbdb7fe2ec9c5655f948f36f36bc550241856ead0445b2b509e2c842ab6c98b4d9dc5dffd18db2cf7226eb1ecb8abedadac1fed59d15d 2.6 KB

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