isSharedArrayBuffer

Test if a value is a SharedArrayBuffer.

Installation

npm install @stdlib/assert-is-sharedarraybuffer

Usage

var isSharedArrayBuffer = require( '@stdlib/assert-is-sharedarraybuffer' );

isSharedArrayBuffer( value )

Tests if a value is a SharedArrayBuffer.

var SharedArrayBuffer = require( '@stdlib/array-shared-buffer' );

var bool;
try {
    bool = isSharedArrayBuffer( new SharedArrayBuffer( 10 ) );
    // returns true
} catch ( err ) {
    console.log( 'Environment does not support SharedArrayBuffers.' );
}

bool = isSharedArrayBuffer( [] );
// returns false

Examples

var Float32Array = require( '@stdlib/array-float32' );
var Float64Array = require( '@stdlib/array-float64' );
var Int8Array = require( '@stdlib/array-int8' );
var Int16Array = require( '@stdlib/array-int16' );
var Int32Array = require( '@stdlib/array-int32' );
var Uint8Array = require( '@stdlib/array-uint8' );
var Uint8ClampedArray = require( '@stdlib/array-uint8c' );
var Uint16Array = require( '@stdlib/array-uint16' );
var Uint32Array = require( '@stdlib/array-uint32' );
var ArrayBuffer = require( '@stdlib/array-buffer' );
var SharedArrayBuffer = require( '@stdlib/array-shared-buffer' );
var isSharedArrayBuffer = require( '@stdlib/assert-is-sharedarraybuffer' );

var bool;
try {
    bool = isSharedArrayBuffer( new SharedArrayBuffer( 10 ) );
    // returns true
} catch ( err ) {
    console.log( 'Environment does not support SharedArrayBuffers.' );
}
bool = isSharedArrayBuffer( new ArrayBuffer( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Float32Array( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Int8Array( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Uint8Array( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Uint8ClampedArray( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Int16Array( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Uint16Array( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Int32Array( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Uint32Array( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Float64Array( 10 ) );
// returns false

bool = isSharedArrayBuffer( new Array( 10 ) );
// returns false

bool = isSharedArrayBuffer( {} );
// returns false

bool = isSharedArrayBuffer( null );
// returns false

See Also

• @stdlib/assert-is-arraybuffer: test if a value is an ArrayBuffer.
• @stdlib/assert-is-typed-array: test if a value is a typed array.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.