https://github.com/jonkemp/flat-util

Small utility to flatten a nested array
https://github.com/jonkemp/flat-util

array flat flatten nested util utility

Last synced: 26 days ago
JSON representation

Small utility to flatten a nested array

• Host: GitHub
• URL: https://github.com/jonkemp/flat-util
• Owner: jonkemp
• License: mit
• Created: 2020-01-22T03:53:09.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-03-22T03:17:11.000Z (over 2 years ago)
• Last Synced: 2024-09-24T01:59:04.400Z (about 1 month ago)
• Topics: array, flat, flatten, nested, util, utility
• Language: JavaScript
• Size: 526 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flat-util ![Build Status](https://github.com/jonkemp/flat-util/actions/workflows/main.yml/badge.svg?branch=master)

> 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](https://npmjs.org/package/flat-util)

```

$ npm install flat-util

```

Or [unpkg](https://unpkg.com/flat-util/)

```

```

Check out the unit tests on [CodePen](https://codepen.io/jonkemp/full/YzPBmwz).

## Usage

```js

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](https://pkgreview.dev/npm/flat-util)** | ➡   | [![Review us on pkgreview.dev](https://i.ibb.co/McjVMfb/pkgreview-dev.jpg)](https://pkgreview.dev/npm/flat-util) |

| ----------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------------------------------------------------------------------------------------------------- |

## 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