8000 GitHub - stdlib-js/assert-is-array-like at 3969f2dacca5af4159d654df12fed85d59dd1c7e
[go: up one dir, main page]

Skip to content

stdlib-js/assert-is-array-like

Repository files navigation

isArrayLike

NPM version Build Status Coverage Status

Test if a value is array-like.

Installation

npm install @stdlib/assert-is-array-like

Alternatively,

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

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

<
8000
span class="pl-s1">bool = isArrayLike( true );
// returns false

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

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

See Also


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2023. The Stdlib Authors.

0