https://github.com/heppokofrontend/flat-deep

The flatDeep() method creates a new array with all sub-iterables elements concatenated into it recursively up.
https://github.com/heppokofrontend/flat-deep

Last synced: 8 days ago
JSON representation

The flatDeep() method creates a new array with all sub-iterables elements concatenated into it recursively up.

• Host: GitHub
• URL: https://github.com/heppokofrontend/flat-deep
• Owner: heppokofrontend
• License: mit
• Created: 2021-05-26T11:20:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-27T20:14:40.000Z (about 2 years ago)
• Last Synced: 2024-10-13T08:08:39.317Z (about 1 month ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@heppokofrontend/flat-deep
• Size: 149 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @heppokofrontend/flat-deep

[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) [![Published on NPM](https://img.shields.io/npm/v/@heppokofrontend/flat-deep.svg)](https://www.npmjs.com/package/@heppokofrontend/flat-deep) ![test workflow](https://github.com/heppokofrontend/flat-deep/actions/workflows/ci.yml/badge.svg)

 [![](https://data.jsdelivr.com/v1/package/npm/@heppokofrontend/flat-deep/badge)](https://www.jsdelivr.com/package/npm/@heppokofrontend/flat-deep) [![Maintainability](https://api.codeclimate.com/v1/badges/bacf4dcc44135e8ef5ec/maintainability)](https://codeclimate.com/github/heppokofrontend/flat-deep/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/bacf4dcc44135e8ef5ec/test_coverage)](https://codeclimate.com/github/heppokofrontend/flat-deep/test_coverage) [![Known Vulnerabilities](https://snyk.io/test/npm/@heppokofrontend/flat-deep/badge.svg)](https://snyk.io/test/npm/@heppokofrontend/flat-deep)

 [![@heppokofrontend/flat-deep](https://snyk.io/advisor/npm-package/@heppokofrontend/flat-deep/badge.svg)](https://snyk.io/advisor/npm-package/@heppokofrontend/flat-deep)

The `flatDeep()` method creates a new array with all sub-iterables elements concatenated into it recursively up.

## Usage

Installation:

```shell

npm install --save @heppokofrontend/flat-deep

```

Example: 

```javascript

import { flatDeep } from '@heppokofrontend/flat-deep';

const map = new Map();

const set = new Set();

const arr = [

  0,

  'hoge',

  [

    1,

    2,

    [

      set,

      map,

    ],

  ],

  6,

];

set.add(3);

map.set(4, [5]);

console.log(flatDeep(arr)); // > [0, 'hoge', 1, 2, 3, 4, 5, 6]

```

## Syntax

```ts

flatDeep(iterable, options);

```

### Parameters

#### `iterable`

The iterable object to be flattened.

For Example:

- Array

- Set

- Map

- NodeList

- HTMLCollection

#### `options`

|property|type|default|required|description|

|---|:-:|:-:|:-:|---|

|`stringIgnore`|`boolean`|`true`|none|Whether to ignore the string type.|

|`circularReferenceToJson`|`boolean`|`false`|none|If a circular reference is found, convert it to JSON without ignoring it. The circular reference will be replaced by the string `[Circular]` (see [fast-safe-stringify](https://www.npmjs.com/package/fast-safe-stringify)).|

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## License

MIT