Home Original page

stdlib/lib/node_modules/@stdlib/assert/is-array-length at develop · stdlib-js/stdlib

isArrayLength

Test if a value is a valid 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

See Also