@stdlib/assert-is-typed-array-like
v0.2.2
Published
Test if a value is typed-array-like.
Downloads
148,659
Readme
isTypedArrayLike
Test if a value is typed-array-like.
Installation
npm install @stdlib/assert-is-typed-array-like
Usage
var isTypedArrayLike = require( '@stdlib/assert-is-typed-array-like' );
isTypedArrayLike( value )
Tests if a value is typed-array-like.
var Int16Array = require( '@stdlib/array-int16' );
var bool = isTypedArrayLike( new Int16Array() );
// returns true
bool = isTypedArrayLike({
'length': 10,
'byteOffset': 0,
'byteLength': 10,
'BYTES_PER_ELEMENT': 4
});
// returns true
Examples
var Int8Array = require( '@stdlib/array-int8' );
var isTypedArrayLike = require( '@stdlib/assert-is-typed-array-like' );
var bool;
var arr;
arr = {
'BYTES_PER_ELEMENT': 8,
'length': 10,
'byteOffset': 0,
'byteLength': 10
};
bool = isTypedArrayLike( arr );
// returns true
bool = isTypedArrayLike( new Int8Array( 4 ) );
// returns true
bool = isTypedArrayLike( [] );
// returns false
bool = isTypedArrayLike( {} );
// returns false
bool = isTypedArrayLike( null );
// returns false
bool = isTypedArrayLike( 'beep' );
// returns false
bool = isTypedArrayLike( function foo( a, b ) {} );
// returns false
See Also
@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.