Sha256: 728966a404dbd35d985c4b0ce0d74698bd8d6d1a29b4d298459633d2b9561aba
Contents?: true
Size: 819 Bytes
Versions: 26
Compression:
Stored size: 819 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 function isIterableObject(maybeIterable) {
return (
typeof maybeIterable === 'object' &&
typeof (maybeIterable === null || maybeIterable === void 0
? void 0
: maybeIterable[Symbol.iterator]) === 'function'
);
}
Version data entries
26 entries across 26 versions & 1 rubygems