isArrayBuffer
Test if a value is an ArrayBuffer.
Installation
npm install @stdlib/assert-is-arraybuffer
Alternatively,
- To load the package in a website via a
script
tag without installation and bundlers, use the ES Module available on theesm
branch. - If you are using Deno, visit the
deno
branch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umd
branch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
Usage
var isArrayBuffer = require( '@stdlib/assert-is-arraybuffer' );
isArrayBuffer( value )
Tests if a value is an ArrayBuffer
.
var ArrayBuffer = require( '@stdlib/array-buffer' );
var bool = isArrayBuffer( new ArrayBuffer( 10 ) );
// returns true
bool = isArrayBuffer( [] );
// 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 isArrayBuffer = require( '@stdlib/assert-is-arraybuffer' );
var bool = isArrayBuffer( new ArrayBuffer( 10 ) );
// returns true
bool = isArrayBuffer( new Float32Array( 10 ) );
// returns false
bool = isArrayBuffer( new Int8Array( 10 ) );
// returns false
bool = isArrayBuffer( new Uint8Array( 10 ) );
// returns false
bool = isArrayBuffer( new Uint8ClampedArray( 10 ) );
// returns false
bool = isArrayBuffer( new Int16Array( 10 ) );
// returns false
bool = isArrayBuffer( new Uint16Array( 10 ) );
// returns false
bool = isArrayBuffer( new Int32Array( 10 ) );
// returns false
bool = isArrayBuffer( new Uint32Array( 10 ) );
// returns false
bool = isArrayBuffer( new Float64Array( 10 ) );
// returns false
bool = isArrayBuffer( new Array( 10 ) );
// returns false
bool = isArrayBuffer( {} );
// returns false
bool = isArrayBuffer( null );
// returns false
See Also
@stdlib/assert-is-sharedarraybuffer
: test if a value is a SharedArrayBuffer.@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-2023. The Stdlib Authors.