1. module array-flatten
   1. function array-flatten (array)
   2. function array-flatten.depth (array, depth)
   3. function array-flatten.from (array)
   4. function array-flatten.fromDepth (array, depth)

module array-flatten

function array-flatten (array)

• description and source-code

  function flatten(array) {
    if (!Array.isArray(array)) {
      throw new TypeError('Expected value to be an array')
    }
  
    return flattenFrom(array)
  }

• example usage

  n/a

function array-flatten.depth (array, depth)

• description and source-code

  function flattenDepth(array, depth) {
    if (!Array.isArray(array)) {
      throw new TypeError('Expected value to be an array')
    }
  
    return flattenFromDepth(array, depth)
  }

• example usage

  ...
  
  ```javascript
  var flatten = require('array-flatten')
  
  flatten([1, [2, [3, [4, [5], 6], 7], 8], 9])
  //=> [1, 2, 3, 4, 5, 6, 7, 8, 9]
  
  flatten.depth([1, [2, [3, [4, [5], 6], 7], 8], 9], 2)
  //=> [1, 2, 3, [4, [5], 6], 7, 8, 9]
  
  (function () {
    flatten.from(arguments) //=> [1, 2, 3]
  })(1, [2, 3])
  ```
  ...

function array-flatten.from (array)

• description and source-code

  function flattenFrom(array) {
    return flattenDown(array, [])
  }

• example usage

  ...
  flatten([1, [2, [3, [4, [5], 6], 7], 8], 9])
  //=> [1, 2, 3, 4, 5, 6, 7, 8, 9]
  
  flatten.depth([1, [2, [3, [4, [5], 6], 7], 8], 9], 2)
  //=> [1, 2, 3, [4, [5], 6], 7, 8, 9]
  
  (function () {
    flatten.from(arguments) //=> [1, 2, 3]
  })(1, [2, 3])
  ```
  
  ### Methods
  
  * **flatten(array)** Flatten a nested array structure
  * **flatten.from(arrayish)** Flatten an array-like structure (E.g. arguments)
  ...

function array-flatten.fromDepth (array, depth)

• description and source-code

  function flattenFromDepth(array, depth) {
    if (typeof depth !== 'number') {
      throw new TypeError('Expected the depth to be a number')
    }
  
    return flattenDownDepth(array, [], depth)
  }

• example usage

  ...
  ```
  
  ### Methods
  
  * **flatten(array)** Flatten a nested array structure
  * **flatten.from(arrayish)** Flatten an array-like structure (E.g. arguments)
  * **flatten.depth(array, depth)** Flatten a nested array structure with a specific depth
  * **flatten.fromDepth(arrayish, depth)** Flatten an array-like structure with a specific
   depth
  
  ## License
  
  MIT
  
  [npm-image]: https://img.shields.io/npm/v/array-flatten.svg?style=flat
  [npm-url]: https://npmjs.org/package/array-flatten
  ...