isArrayLike

Test if a value is array-like.

Installation

npm install @stdlib/assert-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

See Also

• @stdlib/assert-is-array: test if a value is an array.
• @stdlib/assert-is-array-like-object: test if a value is an array-like object.
• @stdlib/assert-is-collection: test if a value is a collection.

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.

Copyright

Copyright © 2016-2024. The Stdlib Authors.