@stdlib/assert-is-iterable-like NPM

isIterableLike

Test if a value is iterable-like.

Installation

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

Usage

var isIterableLike = require( '@stdlib/assert-is-iterable-like' );

isIterableLike( value )

Tests if a value is iterable-like.

var bool = isIterableLike( [] );
// returns <boolean>

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

Notes

In order to be iterable, an object must implement the @@iterator method, which, when called, returns an iterator protocol-compliant object.
An iterator protocol-compliant object is an object having a next method following the iterator protocol.
As full iterator compliance is impossible to achieve without evaluating an iterator, this function checks only for interface compliance.
In environments lacking Symbol.iterator support, this function always returns false.

Examples

var isIterableLike = require( '@stdlib/assert-is-iterable-like' );

var bool = isIterableLike( [] );
// returns <boolean>

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

bool = isIterableLike( null );
// returns false

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.