Skip to content

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

License

Notifications You must be signed in to change notification settings

es-shims/Array.prototype.flat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Dec 15, 2024
a0fa566 · Dec 15, 2024
Dec 15, 2024
Apr 7, 2021
Apr 11, 2022
Nov 2, 2022
Nov 3, 2022
Apr 7, 2021
Dec 15, 2024
Oct 1, 2017
Oct 1, 2021
Jan 18, 2018
Dec 15, 2024
Nov 18, 2020
Dec 15, 2024
May 22, 2018
Apr 11, 2022

Repository files navigation

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