Package Exports

@stdlib/assert-is-array-length
@stdlib/assert-is-array-length/lib/index.js

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-array-length) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

isArrayLength

Test if a value is a valid array length.

Installation

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

Usage

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

isArrayLength( value )

Tests if a value is a valid array length.

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

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

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

bool = isArrayLength( 3.14 );
// returns false

bool = isArrayLength( null );
// returns false

Notes

A valid length property for an Array is any integer value on the interval [0, 2^32-1].

Examples

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

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

bool = isArrayLength( 0 );
// returns true

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

bool = isArrayLength( 5.256 );
// returns false

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

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

bool = isArrayLength( NaN );
// returns false

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

bool = isArrayLength( 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.

Community

License

See LICENSE.

@stdlib/assert-is-array-length