Skip to content

jonkemp/flat-util

Repository files navigation

flat-util Build Status

Flatten a nested array.

The nesting can be to any depth. If you pass shallow, the array will only be flattened one level.

Features

  • Small utility to flatten nested arrays.
  • Free of TypeScript. 😄

Install

Install with npm

$ npm install flat-util

Or unpkg

<script src="/proxy?url=https%3A%2F%2Funpkg.com%2Fflat-util%401.1.9%2Fumd%2Findex.js" />

Check out the unit tests on CodePen.

Usage

const flatten = require('flat-util');

flatten([1, 2, [3, 4]]);
//=> [1, 2, 3, 4]

flatten([1, [2], [3, [[4]]]]);
//=> [1, 2, 3, 4];

flatten([1, [2], [3, [[4]]]], true);
//=> [1, 2, 3, [[4]]];

Like us a lot? Help others know why you like us! Review this package on pkgreview.dev Review us on pkgreview.dev

API

flatten(input, shallow)

input

Type: array
Default: none

The array to flatten.

shallow

Type: boolean
Default: false

Whether or not to flatten the array only one level.

License

MIT

About

Small utility to flatten a nested array

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors