@stdlib/assert-is-typed-array-length NPM

isTypedArrayLength

Test if a value is a valid typed array length.

Installation

npm install @stdlib/assert-is-typed-array-length

Usage

var isTypedArrayLength = require( '@stdlib/assert-is-typed-array-length' );

isTypedArrayLength( value )

Tests if a value is a valid typed array length.

var bool = isTypedArrayLength( 5 );
// returns true

bool = isTypedArrayLength( -1 );
// returns false

bool = isTypedArrayLength( 2.0e200 );
// returns false

bool = isTypedArrayLength( 3.14 );
// returns false

bool = isTypedArrayLength( null );
// returns false

Notes

A valid length property for a typed array is any integer value on the interval [0, 2^53-1].

Examples

var isTypedArrayLength = require( '@stdlib/assert-is-typed-array-length' );

var bool = isTypedArrayLength( 5 );
// returns true

bool = isTypedArrayLength( 0 );
// returns true

bool = isTypedArrayLength( 2.0e200 );
// returns false

bool = isTypedArrayLength( 5.256 );
// returns false

bool = isTypedArrayLength( 1.0/0.0 );
// returns false

bool = isTypedArrayLength( -1.0/0.0 );
// returns false

bool = isTypedArrayLength( NaN );
// returns false

bool = isTypedArrayLength( '5' );
// returns false

bool = isTypedArrayLength( null );
// 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.