time-to-botec/js/node_modules/@stdlib/assert/is-dataview/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.8 KiB

isDataView

Test if a value is a DataView.

Usage

var isDataView = require( '@stdlib/assert/is-dataview' );

isDataView( value )

Tests if a value is a DataView.

var ArrayBuffer = require( '@stdlib/array/buffer' );
var DataView = require( '@stdlib/array/dataview' );

var bool = isDataView( new DataView( new ArrayBuffer( 10 ) ) );
// returns true

bool = isDataView( [] );
// 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 DataView = require( '@stdlib/array/dataview' );
var isDataView = require( '@stdlib/assert/is-dataview' );

var bool = isDataView( new DataView( new ArrayBuffer( 10 ) ) );
// returns true

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

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

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

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

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

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

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

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

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

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

bool = isDataView( new ArrayBuffer( 10 ) );
// returns false

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

bool = isDataView( null );
// returns false