❤Node's Package Magician

npm

Sign UpSign In
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

array.prototype.flat

1.2.4 • Public • Published

array.prototype.flat Version Badge

Build Status 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

Install

npm i array.prototype.flat

Fund this package

DownloadsWeekly Downloads

8,392,843

Version

1.2.4

License

MIT

Unpacked Size

14.7 kB

Total Files

18

Homepage

github.com/es-shims/Array.prototype.flat#readme

Repository

Gitgithub.com/es-shims/Array.prototype.flat

Last publish

Collaborators

  • avatar
Try on RunKit
Report malware