Logo for jsDocs.io

array-flatten

  • Version 3.0.0
  • Published
  • 20.1 kB
  • No dependencies
  • MIT license

Install

npm i array-flatten
yarn add array-flatten
pnpm add array-flatten

Overview

Flatten nested arrays

Index

Functions

Type Aliases

Functions

function flatten

flatten: <T extends ArrayLike<any>>(array: T) => FlatArray<T>;

  • Flatten an array indefinitely.

Type Aliases

type FlatArray

type FlatArray<T extends ArrayLike<any>> = Array<PickValue<T[number]>>;

  • Flatten an ArrayLike object in TypeScript.

type PickValue

type PickValue<T> = T extends ReadonlyArray<any>
    ? {
          [K in Extract<keyof T, number>]: PickValue<T[K]>;
      }[number]
    : T;

  • Pick the value from an array.

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (14)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/array-flatten.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/array-flatten)
  • HTML
    <a href="https://www.jsdocs.io/package/array-flatten"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>