use-memo-map 0.0.0-main.e5a419d → 0.0.0-main.ff61b2d

package/README.md

@@ -4,28 +4,9 @@ Memoizes calls to array map function similar to `React.useMemo`. Memoized result
 
 ## Background
 
-tl;dr, `React.useMemo()` can only cache a single call. `useMemoAll()` cache multiple calls.
+tl;dr, `React.useMemo()` cache a single call. `useMemoMap()` cache multiple calls.
 
-If you have a variable-length array and would like to cache `Array.map` like `useMemo`, you can use `useMemoAll` to cache all calls.
-
-## API
-
-```ts
-type UseMemoMapOptions<T> = {
-  itemEquality?: (this: readonly T[], x: T, y: T) => boolean;
-};
-
-function useMemoMap<T = unknown, R = unknown>(
-  mapper: (this: readonly T[], item: T, index: -1, array: readonly T[]) => R,
-  { itemEquality = Object.is }: UseMemoMapOptions<T> = {}
-): (array: readonly T[]) => readonly R[] {}
-```
-
-For example, converting a `number` array into a `string` array.
-
-```ts
-function useMemoMap(mapper: (item: number) => string): (array: readonly number[]) => readonly string[];
-```
+If you have a variable-length array and would like to cache `Array.map` like `useMemo`, you can use `useMemoMap` to cache all calls.
 
 ## How to use
 
@@ -39,7 +20,7 @@ const MyComponent = () => {
     return value * 10;
   }, []);
 
-  // useMemoMap() will return a function similar to Array.map().
+  // useMemoMap() will return a function that take an array.
   const map = useMemoMap(multiplyBy10);
 
   const output = map([1, 2, 3]); // Returns [10, 20, 30].
@@ -50,6 +31,27 @@ const MyComponent = () => {
 export default MyComponent;
 ```
 
+## API
+
+```ts
+type UseMemoMapOptions<T> = {
+  itemEquality?: (this: readonly T[], x: T, y: T) => boolean;
+};
+
+function useMemoMap<T = unknown, R = unknown>(
+  mapper: (this: readonly T[], item: T, index: -1, array: readonly T[]) => R,
+  { itemEquality = Object.is }: UseMemoMapOptions<T> = {}
+): (array: readonly T[]) => readonly R[] {}
+```
+
+For example, converting a `number` array into a `string` array.
+
+```ts
+function useMemoMap(
+  mapper: (item: number, index: -1, array: readonly number[]) => string
+): (array: readonly number[]) => readonly string[];
+```
+
 ## Behaviors
 
 ### Invalidate all results when mapper function change
@@ -93,7 +95,7 @@ Note: the "cache pool" will be saved during `useEffect()` callback. This is simi
 
 ### Index is always `-1`
 
-Unlike `Array.map()` which pass the `index` value as second argument, `useMemoAll()` will always pass `-1`. This is by design.
+Unlike `Array.map()` which pass the `index` value as second argument, `useMemoMap()` will always pass `-1`. This is by design.
 
 Calls to mapper function could be cached and will not be called again if only `index` has changed. To protect wrong use of `index` value, we pass `-1` instead.
 
@@ -108,3 +110,11 @@ If you prefer mutable array, call `[...result]` to clone the array.
 ### Custom equality function
 
 We use `Object.is` for equality check. You can provide a different equality check via `options.itemEquality`.
+
+## Contributions
+
+Like us? [Star](https://github.com/compulim/use-memo-map/stargazers) us.
+
+Want to make it better? [File](https://github.com/compulim/use-memo-map/issues) us an issue.
+
+Don't like something you see? [Submit](https://github.com/compulim/use-memo-map/pulls) a pull request.

package/lib/commonjs/private/usePrevious.js

@@ -6,8 +6,8 @@ _Object$defineProperty(exports, "__esModule", {
 });
 exports.default = usePrevious;
 var _react = require("react");
-function usePrevious(value) {
-  var ref = (0, _react.useRef)();
+function usePrevious(value, initialValue) {
+  var ref = (0, _react.useRef)(initialValue);
   (0, _react.useEffect)(function () {
     ref.current = value;
   });

package/lib/commonjs/private/usePrevious.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePrevious.js","names":["usePrevious","value","ref","useRef","useEffect","current"],"sources":["../../../src/private/usePrevious.ts"],"sourcesContent":["import { useEffect, useRef } from 'react';\n\nexport default function usePrevious<T>(value: T): T | undefined {\n  const ref = useRef<T>();\n\n  useEffect(() => {\n    ref.current = value;\n  });\n\n  return ref.current;\n}\n"],"mappings":";;;;;;;AAAA;AAEe,SAASA,WAAW,CAAIC,KAAQ,EAAiB;EAC9D,IAAMC,GAAG,GAAG,IAAAC,aAAM,GAAK;EAEvB,IAAAC,gBAAS,EAAC,YAAM;IACdF,GAAG,CAACG,OAAO,GAAGJ,KAAK;EACrB,CAAC,CAAC;EAEF,OAAOC,GAAG,CAACG,OAAO;AACpB"}
+{"version":3,"file":"usePrevious.js","names":["usePrevious","value","initialValue","ref","useRef","useEffect","current"],"sources":["../../../src/private/usePrevious.ts"],"sourcesContent":["import { useEffect, useRef } from 'react';\n\nexport default function usePrevious<T>(value: T, initialValue?: T): T | undefined {\n  const ref = useRef<T | undefined>(initialValue);\n\n  useEffect(() => {\n    ref.current = value;\n  });\n\n  return ref.current;\n}\n"],"mappings":";;;;;;;AAAA;AAEe,SAASA,WAAW,CAAIC,KAAQ,EAAEC,YAAgB,EAAiB;EAChF,IAAMC,GAAG,GAAG,IAAAC,aAAM,EAAgBF,YAAY,CAAC;EAE/C,IAAAG,gBAAS,EAAC,YAAM;IACdF,GAAG,CAACG,OAAO,GAAGL,KAAK;EACrB,CAAC,CAAC;EAEF,OAAOE,GAAG,CAACG,OAAO;AACpB"}

package/lib/commonjs/private/useValueRef.js

@@ -18,7 +18,7 @@ function useValueRef(value) {
         }
       }
     });
-  }, []);
+  }, [ref]);
   ref.current = value;
   return readOnlyRef;
 }

package/lib/commonjs/private/useValueRef.js.map

@@ -1 +1 @@
-{"version":3,"file":"useValueRef.js","names":["useValueRef","value","ref","useRef","readOnlyRef","useMemo","current","get"],"sources":["../../../src/private/useValueRef.ts"],"sourcesContent":["import { RefObject, useMemo, useRef } from 'react';\n\nexport default function useValueRef<T>(value: T): RefObject<T> & { current: T } {\n  const ref = useRef<T>();\n  const readOnlyRef = useMemo(\n    () =>\n      Object.create(\n        {},\n        {\n          current: {\n            get: () => ref.current\n          }\n        }\n      ),\n    []\n  );\n\n  ref.current = value;\n\n  return readOnlyRef;\n}\n"],"mappings":";;;;;;;;;AAAA;AAEe,SAASA,WAAW,CAAIC,KAAQ,EAAiC;EAC9E,IAAMC,GAAG,GAAG,IAAAC,aAAM,GAAK;EACvB,IAAMC,WAAW,GAAG,IAAAC,cAAO,EACzB;IAAA,OACE,qBACE,CAAC,CAAC,EACF;MACEC,OAAO,EAAE;QACPC,GAAG,EAAE;UAAA,OAAML,GAAG,CAACI,OAAO;QAAA;MACxB;IACF,CAAC,CACF;EAAA,GACH,EAAE,CACH;EAEDJ,GAAG,CAACI,OAAO,GAAGL,KAAK;EAEnB,OAAOG,WAAW;AACpB"}
+{"version":3,"file":"useValueRef.js","names":["useValueRef","value","ref","useRef","readOnlyRef","useMemo","current","get"],"sources":["../../../src/private/useValueRef.ts"],"sourcesContent":["import { useMemo, useRef } from 'react';\nimport type { RefObject } from 'react';\n\nexport default function useValueRef<T>(value: T): RefObject<T> & { current: T } {\n  const ref = useRef<T>();\n\n  const readOnlyRef = useMemo(() => Object.create({}, { current: { get: () => ref.current } }), [ref]);\n\n  ref.current = value;\n\n  return readOnlyRef;\n}\n"],"mappings":";;;;;;;;;AAAA;AAGe,SAASA,WAAW,CAAIC,KAAQ,EAAiC;EAC9E,IAAMC,GAAG,GAAG,IAAAC,aAAM,GAAK;EAEvB,IAAMC,WAAW,GAAG,IAAAC,cAAO,EAAC;IAAA,OAAM,qBAAc,CAAC,CAAC,EAAE;MAAEC,OAAO,EAAE;QAAEC,GAAG,EAAE;UAAA,OAAML,GAAG,CAACI,OAAO;QAAA;MAAC;IAAE,CAAC,CAAC;EAAA,GAAE,CAACJ,GAAG,CAAC,CAAC;EAEpGA,GAAG,CAACI,OAAO,GAAGL,KAAK;EAEnB,OAAOG,WAAW;AACpB"}

package/lib/esmodules/private/usePrevious.js

@@ -1,6 +1,6 @@
 import { useEffect, useRef } from 'react';
-export default function usePrevious(value) {
-  var ref = useRef();
+export default function usePrevious(value, initialValue) {
+  var ref = useRef(initialValue);
   useEffect(function () {
     ref.current = value;
   });

package/lib/esmodules/private/usePrevious.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePrevious.js","names":["useEffect","useRef","usePrevious","value","ref","current"],"sources":["../../../src/private/usePrevious.ts"],"sourcesContent":["import { useEffect, useRef } from 'react';\n\nexport default function usePrevious<T>(value: T): T | undefined {\n  const ref = useRef<T>();\n\n  useEffect(() => {\n    ref.current = value;\n  });\n\n  return ref.current;\n}\n"],"mappings":"AAAA,SAASA,SAAS,EAAEC,MAAM,QAAQ,OAAO;AAEzC,eAAe,SAASC,WAAW,CAAIC,KAAQ,EAAiB;EAC9D,IAAMC,GAAG,GAAGH,MAAM,EAAK;EAEvBD,SAAS,CAAC,YAAM;IACdI,GAAG,CAACC,OAAO,GAAGF,KAAK;EACrB,CAAC,CAAC;EAEF,OAAOC,GAAG,CAACC,OAAO;AACpB"}
+{"version":3,"file":"usePrevious.js","names":["useEffect","useRef","usePrevious","value","initialValue","ref","current"],"sources":["../../../src/private/usePrevious.ts"],"sourcesContent":["import { useEffect, useRef } from 'react';\n\nexport default function usePrevious<T>(value: T, initialValue?: T): T | undefined {\n  const ref = useRef<T | undefined>(initialValue);\n\n  useEffect(() => {\n    ref.current = value;\n  });\n\n  return ref.current;\n}\n"],"mappings":"AAAA,SAASA,SAAS,EAAEC,MAAM,QAAQ,OAAO;AAEzC,eAAe,SAASC,WAAW,CAAIC,KAAQ,EAAEC,YAAgB,EAAiB;EAChF,IAAMC,GAAG,GAAGJ,MAAM,CAAgBG,YAAY,CAAC;EAE/CJ,SAAS,CAAC,YAAM;IACdK,GAAG,CAACC,OAAO,GAAGH,KAAK;EACrB,CAAC,CAAC;EAEF,OAAOE,GAAG,CAACC,OAAO;AACpB"}

package/lib/esmodules/private/useValueRef.js

@@ -10,7 +10,7 @@ export default function useValueRef(value) {
         }
       }
     });
-  }, []);
+  }, [ref]);
   ref.current = value;
   return readOnlyRef;
 }

package/lib/esmodules/private/useValueRef.js.map

@@ -1 +1 @@
-{"version":3,"file":"useValueRef.js","names":["useMemo","useRef","useValueRef","value","ref","readOnlyRef","current","get"],"sources":["../../../src/private/useValueRef.ts"],"sourcesContent":["import { RefObject, useMemo, useRef } from 'react';\n\nexport default function useValueRef<T>(value: T): RefObject<T> & { current: T } {\n  const ref = useRef<T>();\n  const readOnlyRef = useMemo(\n    () =>\n      Object.create(\n        {},\n        {\n          current: {\n            get: () => ref.current\n          }\n        }\n      ),\n    []\n  );\n\n  ref.current = value;\n\n  return readOnlyRef;\n}\n"],"mappings":";AAAA,SAAoBA,OAAO,EAAEC,MAAM,QAAQ,OAAO;AAElD,eAAe,SAASC,WAAW,CAAIC,KAAQ,EAAiC;EAC9E,IAAMC,GAAG,GAAGH,MAAM,EAAK;EACvB,IAAMI,WAAW,GAAGL,OAAO,CACzB;IAAA,OACE,eACE,CAAC,CAAC,EACF;MACEM,OAAO,EAAE;QACPC,GAAG,EAAE;UAAA,OAAMH,GAAG,CAACE,OAAO;QAAA;MACxB;IACF,CAAC,CACF;EAAA,GACH,EAAE,CACH;EAEDF,GAAG,CAACE,OAAO,GAAGH,KAAK;EAEnB,OAAOE,WAAW;AACpB"}
+{"version":3,"file":"useValueRef.js","names":["useMemo","useRef","useValueRef","value","ref","readOnlyRef","current","get"],"sources":["../../../src/private/useValueRef.ts"],"sourcesContent":["import { useMemo, useRef } from 'react';\nimport type { RefObject } from 'react';\n\nexport default function useValueRef<T>(value: T): RefObject<T> & { current: T } {\n  const ref = useRef<T>();\n\n  const readOnlyRef = useMemo(() => Object.create({}, { current: { get: () => ref.current } }), [ref]);\n\n  ref.current = value;\n\n  return readOnlyRef;\n}\n"],"mappings":";AAAA,SAASA,OAAO,EAAEC,MAAM,QAAQ,OAAO;AAGvC,eAAe,SAASC,WAAW,CAAIC,KAAQ,EAAiC;EAC9E,IAAMC,GAAG,GAAGH,MAAM,EAAK;EAEvB,IAAMI,WAAW,GAAGL,OAAO,CAAC;IAAA,OAAM,eAAc,CAAC,CAAC,EAAE;MAAEM,OAAO,EAAE;QAAEC,GAAG,EAAE;UAAA,OAAMH,GAAG,CAACE,OAAO;QAAA;MAAC;IAAE,CAAC,CAAC;EAAA,GAAE,CAACF,GAAG,CAAC,CAAC;EAEpGA,GAAG,CAACE,OAAO,GAAGH,KAAK;EAEnB,OAAOE,WAAW;AACpB"}

package/lib/types/private/usePrevious.d.ts

@@ -1 +1 @@
-export default function usePrevious<T>(value: T): T | undefined;
+export default function usePrevious<T>(value: T, initialValue?: T): T | undefined;

package/lib/types/private/useValueRef.d.ts

@@ -1,4 +1,4 @@
-import { RefObject } from 'react';
+import type { RefObject } from 'react';
 export default function useValueRef<T>(value: T): RefObject<T> & {
     current: T;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-memo-map",
-  "version": "0.0.0-main.e5a419d",
+  "version": "0.0.0-main.ff61b2d",
   "description": "",
   "files": [
     "./lib/*"
@@ -23,6 +23,7 @@
     "build:babel:commonjs": "babel src --config-file ./babel.commonjs.config.json --extensions .ts,.tsx --out-dir ./lib/commonjs/",
     "build:babel:esmodules": "babel src --config-file ./babel.esmodules.config.json --extensions .ts,.tsx --out-dir ./lib/esmodules/",
     "build:typescript": "tsc --project ./src/tsconfig.declaration.json",
+    "precommit": "eslint ./src/",
     "test": "jest"
   },
   "repository": {