array.prototype.flatmap

compare this package
fund

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

License
MIT
Deps
4(-)
View dependency graphInspect dependency tree
Install Size
20.9 kB(4.7 MB)
Vulns
0
Published

Get started

$npm install array.prototype.flatmap
$pnpm add array.prototype.flatmap
$yarn add array.prototype.flatmap
$bun add array.prototype.flatmap
$deno add npm:array.prototype.flatmap
$vlt install array.prototype.flatmap
$vp add array.prototype.flatmap
$npm install -D @types/array.prototype.flatmapView @types/array.prototype.flatmap
$pnpm add -D @types/array.prototype.flatmapView @types/array.prototype.flatmap
$yarn add -D @types/array.prototype.flatmapView @types/array.prototype.flatmap
$bun add -d @types/array.prototype.flatmapView @types/array.prototype.flatmap
$deno add -D npm:@types/array.prototype.flatmapView @types/array.prototype.flatmap
$vlt install -D @types/array.prototype.flatmapView @types/array.prototype.flatmap
$vp add -D @types/array.prototype.flatmapView @types/array.prototype.flatmap

You might not need this dependency.

This package can be replaced with Array.prototype.flatMap, available since Node 11.0.0.Learn more

Weekly DownloadsAcross all versions

Compatibility

Node.js
>= 0.4

Versions

View all versions
1.3.3
latest

Dependencies (4)

Keywords

Maintainers

Readme

array.prototype.flatmap Version Badge

github actions coverage dependency status dev dependency status License Downloads

npm badge

An ES2019 spec-compliant Array.prototype.flatMap 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 spec.

Because Array.prototype.flatMap 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.flatmap

Usage/Examples

var flatMap = require('array.prototype.flatmap');
var assert = require('assert');

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

var results = flatMap(arr, function (x, i) {
	assert.equal(x, arr[i]);
	return x;
});

assert.deepEqual(results, [1, 2, 3]);
var flatMap = require('array.prototype.flatmap');
var assert = require('assert');
/* when Array#flatMap is not present */
delete Array.prototype.flatMap;
var shimmedFlatMap = flatMap.shim();

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

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

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

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

Tests

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