Test if a value is array-like.
npm install @stdlib/assert-is-array-like
Alternatively,
- To load the package in a website via a
script
tag without installation and bundlers, use the ES Module available on theesm
branch. - If you are using Deno, visit the
deno
branch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umd
branch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var isArrayLike = require( '@stdlib/assert-is-array-like' );
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
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
@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.
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.
See LICENSE.
Copyright © 2016-2022. The Stdlib Authors.