memoize-id - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
   "name": "memoize-id",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Memoize a function by the identity of its arguments",
-  "main": "index.js",
+  "main": "lib/index.js",
   "scripts": {
+    "build": "babel src --out-dir lib",
     "jest": "jest",
     "lint": "eslint .",
+    "prepublish": "npm run build",
     "test": "npm run lint && npm run jest"
@@ -36,3 +38,3 @@ },
     "testPathDirs": [
-      "<rootDir>"
+      "<rootDir>/src"
     ],
@@ -39,0 +41,0 @@ "unmockedModulePathPatterns": [

README.md

@@ -1,2 +0,55 @@
-# memoize-id
-Memoize a function by the identity of its arguments, using ES2015 Map
+# memoize-id [![npm][npm-badge]][npm] [![Build Status][travis-badge]][travis]
+Memoize a function by the identity of its arguments, using [ES2015 Map][Map].
+
+### Installation
+```shell
+npm install memoize-id
+```
+
+_Note: ES2015 [Symbol][] and [Map][] must be available where memoize-id is used. Refer to [ECMAScript 6 compatibility table](https://kangax.github.io/compat-table/es6/)._
+
+### Usage
+```js
+import memoize from 'memoize-id';
+// or:
+// const memoize = require('memoize-id').default;
+
+let i = 0;
+function fn(foo, bar, baz) {
+  i += 1;
+  return {
+    args: [foo, bar, baz],
+    i,
+  };
+}
+const memoizedFn = memoize(fn);
+
+console.log(i);
+// 0
+const v1 = memoizedFn('foo', 'bar', 'baz');
+console.log(v1);
+// { args: ['foo', 'bar', 'baz'], i: 1 }
+console.log(i);
+// 1
+const v2 = memoizedFn('foo', 'bar', 'baz');
+console.log(v2);
+// { args: ['foo', 'bar', 'baz'], i: 1 }
+console.log(v1 === v2);
+// true
+console.log(i);
+// 1
+const v3 = memoizedFn('foo', 'qux', 'baz');
+console.log(v3);
+// { args: ['foo', 'qux', 'baz'], i: 2 }
+console.log(i);
+// 2
+console.log(v1 == v3);
+// false
+```
+
+[Map]: (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
+[Symbol]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Symbol
+[npm]: https://www.npmjs.com/package/memoize-id
+[npm-badge]: https://img.shields.io/npm/v/memoize-id.svg
+[travis]: https://travis-ci.org/elliottsj/memoize-id
+[travis-badge]: https://travis-ci.org/elliottsj/memoize-id.svg?branch=master

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9199

increased by22.46%

Number of package files

10

increased by25%

Lines of code

169

increased by1.2%

Number of lines in readme file

56

increased by1766.67%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes