time-to-botec/squiggle/node_modules/@stdlib/assert/is-array-like/README.md

isArrayLike

Test if a value is array-like.

Usage

var isArrayLike = require( '@stdlib/assert/is-array-like' );

isArrayLike( value )

Tests if a value is array-like.

var bool = isArrayLike( [] );
// returns true

bool = isArrayLike( { 'length': 10 } );
// returns true

If provided a string, the function returns true.

var bool = isArrayLike( 'beep' );
// returns true

Examples

var isArrayLike = require( '@stdlib/assert/is-array-like' );

var bool = isArrayLike( { 'length': 10 } );
// returns true

bool = isArrayLike( [] );
// returns true

bool = isArrayLike( 'beep' );
// returns true

bool = (function test() {
    return isArrayLike( arguments );
})();
// returns true

bool = isArrayLike( null );
// returns false

bool = isArrayLike( void 0 );
// returns false

bool = isArrayLike( 5 );
// returns false

bool = isArrayLike( true );
// returns false

bool = isArrayLike( {} );
// returns false

bool = isArrayLike( function noop() {} );
// returns false