isIterable.js

/**
 * Type detection beyond `typeof`
 * 
 * Copyright (C) 2022  Dieter Raber
 * https://opensource.org/licenses/MIT
 */
import getType from "./getType.js";

/**
 * Check if a value is an Iterable
 * @param {*} value The value to check
 * @returns {Boolean}
 * @example
 * const v1 = [1, 2, 3];
 * isIterable(v1); // true 
 * 
 * const v2 = new Map();
 * isIterable(v2); // true 
 * 
 * const v3 = {};
 * isIterable(v3); // false
 */
const isIterable = (value) => Symbol.iterator in Object(value) && getType(value[Symbol.iterator]) === 'Function';

export default isIterable;