59 lines
2.7 KiB
Markdown
59 lines
2.7 KiB
Markdown
# is-shared-array-buffer <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
|
|
|
[![github actions][actions-image]][actions-url]
|
|
[![coverage][codecov-image]][codecov-url]
|
|
[![dependency status][deps-svg]][deps-url]
|
|
[![dev dependency status][dev-deps-svg]][dev-deps-url]
|
|
[![License][license-image]][license-url]
|
|
[![Downloads][downloads-image]][downloads-url]
|
|
|
|
[![npm badge][npm-badge-png]][package-url]
|
|
|
|
Is this value a JS SharedArrayBuffer? This module works cross-realm/iframe, does not depend on `instanceof` or mutable properties, and despite ES6 Symbol.toStringTag.
|
|
|
|
## Example
|
|
|
|
```js
|
|
var assert = require('assert');
|
|
var isSharedArrayBuffer = require('is-shared-array-buffer');
|
|
|
|
assert(!isSharedArrayBuffer(function () {}));
|
|
assert(!isSharedArrayBuffer(null));
|
|
assert(!isSharedArrayBuffer(function* () { yield 42; return Infinity; });
|
|
assert(!isSharedArrayBuffer(Symbol('foo')));
|
|
assert(!isSharedArrayBuffer(1n));
|
|
assert(!isSharedArrayBuffer(Object(1n)));
|
|
|
|
assert(!isSharedArrayBuffer(new Set()));
|
|
assert(!isSharedArrayBuffer(new WeakSet()));
|
|
assert(!isSharedArrayBuffer(new Map()));
|
|
assert(!isSharedArrayBuffer(new WeakMap()));
|
|
assert(!isSharedArrayBuffer(new WeakRef({})));
|
|
assert(!isSharedArrayBuffer(new FinalizationRegistry(() => {})));
|
|
assert(!isSharedArrayBuffer(new ArrayBuffer()));
|
|
|
|
assert(isSharedArrayBuffer(new SharedArrayBuffer()));
|
|
|
|
class MySharedArrayBuffer extends SharedArrayBuffer {}
|
|
assert(isSharedArrayBuffer(new MySharedArrayBuffer()));
|
|
```
|
|
|
|
## Tests
|
|
Simply clone the repo, `npm install`, and run `npm test`
|
|
|
|
[package-url]: https://npmjs.org/package/is-shared-array-buffer
|
|
[npm-version-svg]: https://versionbadg.es/inspect-js/is-shared-array-buffer.svg
|
|
[deps-svg]: https://david-dm.org/inspect-js/is-shared-array-buffer.svg
|
|
[deps-url]: https://david-dm.org/inspect-js/is-shared-array-buffer
|
|
[dev-deps-svg]: https://david-dm.org/inspect-js/is-shared-array-buffer/dev-status.svg
|
|
[dev-deps-url]: https://david-dm.org/inspect-js/is-shared-array-buffer#info=devDependencies
|
|
[npm-badge-png]: https://nodei.co/npm/is-shared-array-buffer.png?downloads=true&stars=true
|
|
[license-image]: https://img.shields.io/npm/l/is-shared-array-buffer.svg
|
|
[license-url]: LICENSE
|
|
[downloads-image]: https://img.shields.io/npm/dm/is-shared-array-buffer.svg
|
|
[downloads-url]: https://npm-stat.com/charts.html?package=is-shared-array-buffer
|
|
[codecov-image]: https://codecov.io/gh/inspect-js/is-shared-array-buffer/branch/main/graphs/badge.svg
|
|
[codecov-url]: https://app.codecov.io/gh/inspect-js/is-shared-array-buffer/
|
|
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/is-shared-array-buffer
|
|
[actions-url]: https://github.com/inspect-js/is-shared-array-buffer/actions
|