array.prototype.flatmap - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -0,3 +1,7 @@
+1.0.1 / 2017-10-02
+=================
+  * Add readme
+
 1.0.0 / 2017-10-01
 =================
   * Initial release

package.json

 {
 	"name": "array.prototype.flatmap",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"author": {
@@ -5,0 +5,0 @@ "name": "Jordan Harband",

README.md

@@ -1,2 +0,79 @@
-# Array.prototype.flatMap
-ESnext spec-compliant shim for Array.prototype.flatMap
+# array.prototype.flatmap <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
+
+[![Build Status][travis-svg]][travis-url]
+[![dependency status][deps-svg]][deps-url]
+[![dev dependency status][dev-deps-svg]][dev-deps-url]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
+[![npm badge][npm-badge-png]][package-url]
+
+An ESnext spec-compliant `Array.prototype.flatMap` shim/polyfill/replacement that works as far down as ES3.
+
+This package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the proposed [spec](https://tc39.github.io/proposal-flatMap/).
+
+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
+
+```sh
+npm install --save array.prototype.flatmap
+```
+
+## Usage/Examples
+
+```js
+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]);
+```
+
+```js
+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));
+```
+
+```js
+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`
+
+[package-url]: https://npmjs.org/package/array.prototype.flatmap
+[npm-version-svg]: http://versionbadg.es/es-shims/Array.prototype.flatMap.svg
+[travis-svg]: https://travis-ci.org/es-shims/Array.prototype.flatMap.svg
+[travis-url]: https://travis-ci.org/es-shims/Array.prototype.flatMap
+[deps-svg]: https://david-dm.org/es-shims/Array.prototype.flatMap.svg
+[deps-url]: https://david-dm.org/es-shims/Array.prototype.flatMap
+[dev-deps-svg]: https://david-dm.org/es-shims/Array.prototype.flatMap/dev-status.svg
+[dev-deps-url]: https://david-dm.org/es-shims/Array.prototype.flatMap#info=devDependencies
+[npm-badge-png]: https://nodei.co/npm/array.prototype.flatmap.png?downloads=true&stars=true
+[license-image]: http://img.shields.io/npm/l/array.prototype.flatmap.svg
+[license-url]: LICENSE
+[downloads-image]: http://img.shields.io/npm/dm/array.prototype.flatmap.svg
+[downloads-url]: http://npm-stat.com/charts.html?package=array.prototype.flatmap

No alert changes

Improved metrics

Total package byte prevSize

18575

increased by18.06%

Number of lines in readme file

80

increased by2566.67%

No dependency changes