Sha256: cd8e71f14d2d45d0333414ca2c37fa4b7a7ea67494ff94166b849380c0c56cb0
Contents?: true
Size: 949 Bytes
Versions: 14
Compression:
Stored size: 949 Bytes
Contents
var baseFlatten = require('../internal/baseFlatten'),
isIterateeCall = require('../internal/isIterateeCall');
/**
* Flattens a nested array. If `isDeep` is `true` the array is recursively
* flattened, otherwise it is only flattened a single level.
*
* @static
* @memberOf _
* @category Array
* @param {Array} array The array to flatten.
* @param {boolean} [isDeep] Specify a deep flatten.
* @param- {Object} [guard] Enables use as a callback for functions like `_.map`.
* @returns {Array} Returns the new flattened array.
* @example
*
* _.flatten([1, [2], [3, [[4]]]]);
* // => [1, 2, 3, [[4]]];
*
* // using `isDeep`
* _.flatten([1, [2], [3, [[4]]]], true);
* // => [1, 2, 3, 4];
*/
function flatten(array, isDeep, guard) {
var length = array ? array.length : 0;
if (guard && isIterateeCall(array, isDeep, guard)) {
isDeep = false;
}
return length ? baseFlatten(array, isDeep) : [];
}
module.exports = flatten;
Version data entries
14 entries across 7 versions & 1 rubygems