array.prototype.flat
Advanced tools
Package description
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.
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)Lodash's flatten method is similar to array.prototype.flat but only flattens one level deep by default. Lodash also offers `flattenDeep` for deep flattening and `flattenDepth` to specify the depth, providing more flexibility compared to array.prototype.flat.
Underscore's flatten function is another alternative, which by default flattens the array completely. It offers less control over the depth of flattening compared to array.prototype.flat, but it's useful for fully flattening arrays.
Ramda's flatten function offers functionality similar to array.prototype.flat, but like Underscore, it does not allow specifying the depth. It's part of a larger functional programming library, making it a good choice if you're already using Ramda for other purposes.
Changelog
v1.3.1 - 2022-11-02
npmignore to autogenerate an npmignore file e339ed7auto-changelog bb5cbd6define-properties, es-abstract 8067910d4d9b28aud, object-inspect, tape d9d7300shim/auto: add flat to Symbol.unscopableses-abstracteslint, @ljharb/eslint-config, @es-shims/api, aud, auto-changelog, object-inspect, safe-publish-latest, tapecall-bind, es-abstracteslint, @ljharb/eslint-config, @es-shims/api, aud, has-strict-mode, object-inspect, tapeprepublishOnly, for npm 7+node/install instead of node/run; use codecov actiones-abstract; add call-bind where applicableeslint, @ljharb/eslint-config, aud, object-inspect, tapenyc on all testsimplementation test; run es-shim-api in postlint; use tape runnerpull_request_target eventes-abstract (65% bundle size decrease)es-abstracteslint, @ljharb/eslint-config, safe-publish-latest, object-inspectfunding fieldes-abstract, define-propertieseslint, @ljharb/eslint-config, covert, evalmd, object-inspect, safe-publish-latest, tapenpx aud instead of nsp or npm audit with hoopsnode v12.11, v11.15, v10.16, v9.11, v8.16, v6.17, v4.9; use nvm install-latest-npmeslint, nsp, tapenode v9.6, v6.13eslintnode v9.4es-abstracteslint, nspnode v9.2, v8.9, v6.12; pin included builds to LTS.FlattenIntoArray: add assertion that thisArg and mapperFunction are both passed togetherReadme
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.
npm install --save array.prototype.flat
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));
Simply clone the repo, npm install, and run npm test
FAQs
An ES2019 spec-compliant `Array.prototype.flat` shim/polyfill/replacement that works as far down as ES3.
The npm package array.prototype.flat receives a total of 19,291,017 weekly downloads. As such, array.prototype.flat popularity was classified as popular.
We found that array.prototype.flat demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.