type-enforcer/src/checks/isArray.js

Type enforcement library for javascript

import { isArray } from 'lodash';
import { buildCheckWithCoerce } from './checks';
import isJson from './isJson';

/**
 * Check if a value is an [array]{@link https://lodash.com/docs/#isArray}
 *
 * @example
 * ``` javascript
 * import { isArray } from 'type-enforcer';
 *
 * isArray([]);
 * // => true
 *
 * isArray('[]');
 * // => false
 *
 * isArray('[]', true);
 * // => true
 * ```
 *
 * @function isArray
 *
 * @arg {*} value
 * @arg {Boolean} [coerce=false] - If true then see if the value can be coerced into an array
 *
 * @returns {Boolean}
 */
export default buildCheckWithCoerce(isArray, (value) => isJson(value) && isArray(JSON.parse(value)));