Socket
Socket
Sign inDemoInstall

array.prototype.flat

Package Overview
Dependencies
61
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

array.prototype.flat

An ES2019 spec-compliant `Array.prototype.flat` shim/polyfill/replacement that works as far down as ES3.

    1.3.2latest
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
20,030,468
decreased by-16.05%

Weekly downloads

Package description

What is array.prototype.flat?

The array.prototype.flat package provides functionality to flatten arrays up to a specified depth. This is particularly useful for dealing with nested arrays, allowing developers to easily manipulate and access elements within deeply nested structures. The package offers a polyfill for the Array.prototype.flat method, which is part of the ECMAScript 2019 standard but may not be available in all environments.

What are array.prototype.flat's main functionalities?

Flattening arrays

This feature allows you to flatten nested arrays up to a specified depth. In the code sample, the array is flattened up to 2 levels deep, resulting in [1, 2, 3, [4], 5].

[1, [2, [3, [4]], 5]].flat(2)

Other packages similar to array.prototype.flat

Changelog

Source

v1.3.2 - 2023-09-05

Commits

  • [Deps] update define-properties, es-abstract fb625eb
  • [Dev Deps] update @es-shims/api, @ljharb/eslint-config, aud, object-inspect, tape 1fde275

Readme

Source

array.prototype.flat Version Badge

github actions coverage dependency status dev dependency status License Downloads

npm badge

An ES2019 spec-compliant Array.prototype.flat shim/polyfill/replacement that works as far down as ES3.

This package implements the es-shim API interface. It works in an ES3-supported environment and complies with the proposed spec.

Because Array.prototype.flat depends on a receiver (the this value), the main export takes the array to operate on as the first argument.

Getting started

npm install --save array.prototype.flat

Usage/Examples

var flat = require('array.prototype.flat');
var assert = require('assert');

var arr = [1, [2], [], 3, [[4]]];

assert.deepEqual(flat(arr, 1), [1, 2, 3, [4]]);
var flat = require('array.prototype.flat');
var assert = require('assert');
/* when Array#flat is not present */
delete Array.prototype.flat;
var shimmedFlat = flat.shim();

assert.equal(shimmedFlat, flat.getPolyfill());
assert.deepEqual(arr.flat(), flat(arr));
var flat = require('array.prototype.flat');
var assert = require('assert');
/* when Array#flat is present */
var shimmedIncludes = flat.shim();

var mapper = function (x) { return [x, 1]; };

assert.equal(shimmedIncludes, Array.prototype.flat);
assert.deepEqual(arr.flat(mapper), flat(arr, mapper));

Tests

Simply clone the repo, npm install, and run npm test

Keywords

FAQs

Last updated on 06 Sep 2023

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc