Skip to content

is-array-length

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

is-array-length

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

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