Sha256: 95a6f851b4c2b4c172b934ada2ab4413e4d1072501d330a5f0ff681970300feb
Contents?: true
Size: 680 Bytes
Versions: 26
Compression:
Stored size: 680 Bytes
Contents
/**
* Returns true if the provided object is an Object (i.e. not a string literal)
* and implements the Iterator protocol.
*
* This may be used in place of [Array.isArray()][isArray] to determine if
* an object should be iterated-over e.g. Array, Map, Set, Int8Array,
* TypedArray, etc. but excludes string literals.
*
* @example
* ```ts
* isIterableObject([ 1, 2, 3 ]) // true
* isIterableObject(new Map()) // true
* isIterableObject('ABC') // false
* isIterableObject({ key: 'value' }) // false
* isIterableObject({ length: 1, 0: 'Alpha' }) // false
* ```
*/
export declare function isIterableObject(
maybeIterable: any,
): maybeIterable is Iterable<unknown>;
Version data entries
26 entries across 26 versions & 1 rubygems