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

isIterableLike

Test if a value 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