the-forest/client/node_modules/is-weakset/README.md

51 lines
1.9 KiB
Markdown
Raw Normal View History

2024-09-17 20:35:18 -04:00
# is-weakset <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
[![github actions][actions-image]][actions-url]
[![coverage][codecov-image]][codecov-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
[![npm badge][npm-badge-png]][package-url]
Is this value a JS WeakSet? This module works cross-realm/iframe, and despite ES6 @@toStringTag.
## Example
```js
var isWeakSet = require('is-weakset');
assert(!isWeakSet(function () {}));
assert(!isWeakSet(null));
assert(!isWeakSet(function* () { yield 42; return Infinity; });
assert(!isWeakSet(Symbol('foo')));
assert(!isWeakSet(1n));
assert(!isWeakSet(Object(1n)));
assert(!isWeakSet(new Set()));
assert(!isWeakSet(new WeakMap()));
assert(!isWeakSet(new Map()));
assert(isWeakSet(new WeakSet()));
class MyWeakSet extends WeakSet {}
assert(isWeakSet(new MyWeakSet()));
```
## Tests
Simply clone the repo, `npm install`, and run `npm test`
[package-url]: https://npmjs.org/package/is-weakset
[npm-version-svg]: https://versionbadg.es/inspect-js/is-weakset.svg
[deps-svg]: https://david-dm.org/inspect-js/is-weakset.svg
[deps-url]: https://david-dm.org/inspect-js/is-weakset
[dev-deps-svg]: https://david-dm.org/inspect-js/is-weakset/dev-status.svg
[dev-deps-url]: https://david-dm.org/inspect-js/is-weakset#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/is-weakset.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/is-weakset.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/is-weakset.svg
[downloads-url]: https://npm-stat.com/charts.html?package=is-weakset
[codecov-image]: https://codecov.io/gh/inspect-js/is-weakset/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/inspect-js/is-weakset/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/is-weakset
[actions-url]: https://github.com/inspect-js/is-weakset/actions