Sha256: 6d5c7a155d52142d0918de4548470396ba46577756404a6f618099a04a7575bf

Contents?: true

Size: 1.94 KB

Versions: 68

Compression:

Stored size: 1.94 KB

Contents

'use strict'

/**
 * Expose `arrayFlatten`.
 */
module.exports = flatten
module.exports.from = flattenFrom
module.exports.depth = flattenDepth
module.exports.fromDepth = flattenFromDepth

/**
 * Flatten an array.
 *
 * @param  {Array} array
 * @return {Array}
 */
function flatten (array) {
  if (!Array.isArray(array)) {
    throw new TypeError('Expected value to be an array')
  }

  return flattenFrom(array)
}

/**
 * Flatten an array-like structure.
 *
 * @param  {Array} array
 * @return {Array}
 */
function flattenFrom (array) {
  return flattenDown(array, [])
}

/**
 * Flatten an array-like structure with depth.
 *
 * @param  {Array}  array
 * @param  {number} depth
 * @return {Array}
 */
function flattenDepth (array, depth) {
  if (!Array.isArray(array)) {
    throw new TypeError('Expected value to be an array')
  }

  return flattenFromDepth(array, depth)
}

/**
 * Flatten an array-like structure with depth.
 *
 * @param  {Array}  array
 * @param  {number} depth
 * @return {Array}
 */
function flattenFromDepth (array, depth) {
  if (typeof depth !== 'number') {
    throw new TypeError('Expected the depth to be a number')
  }

  return flattenDownDepth(array, [], depth)
}

/**
 * Flatten an array indefinitely.
 *
 * @param  {Array} array
 * @param  {Array} result
 * @return {Array}
 */
function flattenDown (array, result) {
  for (var i = 0; i < array.length; i++) {
    var value = array[i]

    if (Array.isArray(value)) {
      flattenDown(value, result)
    } else {
      result.push(value)
    }
  }

  return result
}

/**
 * Flatten an array with depth.
 *
 * @param  {Array}  array
 * @param  {Array}  result
 * @param  {number} depth
 * @return {Array}
 */
function flattenDownDepth (array, result, depth) {
  depth--

  for (var i = 0; i < array.length; i++) {
    var value = array[i]

    if (depth > -1 && Array.isArray(value)) {
      flattenDownDepth(value, result, depth)
    } else {
      result.push(value)
    }
  }

  return result
}

Version data entries

68 entries across 67 versions & 12 rubygems

Version Path
sumomo-0.10.8 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
optimacms-0.1.61 spec/dummy/node_modules/bonjour/node_modules/array-flatten/array-flatten.js
sumomo-0.10.4 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.10.3 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.10.2 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.10.1 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.10.0 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.9.0 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.8.22 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.8.21 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.8.20 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.8.17 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.8.16 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
disco_app-0.18.0 test/dummy/node_modules/bonjour/node_modules/array-flatten/array-flatten.js
disco_app-0.18.2 test/dummy/node_modules/bonjour/node_modules/array-flatten/array-flatten.js
sumomo-0.8.15 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
disco_app-0.16.1 test/dummy/node_modules/bonjour/node_modules/array-flatten/array-flatten.js
sumomo-0.8.14 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
sumomo-0.8.13 data/sumomo/api_modules/node_modules/array-flatten/array-flatten.js
disco_app-0.15.2 test/dummy/node_modules/bonjour/node_modules/array-flatten/array-flatten.js