Package Exports

@stdlib/assert-is-typed-array-like

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/assert-is-typed-array-like) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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

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.

@stdlib/assert-is-typed-array-like