V5

.gitignore

@@ -2,6 +2,7 @@
 .nyc_output
 coverage
 dist
+dist-prev
 es
 node_modules
 lib

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "all",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2
+}

.release-it.beta.json

@@ -2,11 +2,16 @@
   "github": {
     "release": true
   },
+  "hooks": {
+    "before:init": [
+      "npm run typecheck",
+      "npm run lint",
+      "npm run test:coverage",
+      "npm run build"
+    ]
+  },
   "npm": {
     "tag": "next"
   },
-  "preReleaseId": "beta",
-  "scripts": {
-    "beforeStart": "npm run prepublish:compile"
-  }
+  "preReleaseId": "beta"
 }

.release-it.json

@@ -3,7 +3,12 @@
     "release": true,
     "tagName": "v${version}"
   },
-  "scripts": {
-    "beforeStart": "npm run prepublish:compile"
+  "hooks": {
+    "before:init": [
+      "npm run typecheck",
+      "npm run lint",
+      "npm run test:coverage",
+      "npm run build"
+    ]
   }
 }

CHANGELOG.md

@@ -1,5 +1,31 @@
 # micro-memoize CHANGELOG
 
+## 5.0.0
+
+**Smaller, faster, with more features**
+
+This is a complete rewrite of the library that improves bundle size and runtime performance while also offering more features. If you are using the simple use case of `memoize(fn)` then you should have no impact. However, if you were making use of specific options, you will be impacted.
+
+### Breaking changes
+
+- `isPromise` has been renamed to `async`, to more clearly identify the type of function it is vs what the result of calling it will be
+- `isEqual` has been renamed to `isArgEqual`, for better clarity vs `isMatchingKey`
+- `isMatchingKey` has been renamed to `isKeyEqual`, for better clarity vs `isEqual`
+- `onCacheAdd` / `onCacheChange` / `onCacheHit` has been rearchitected entirely into a dynamic event listener on the `memoized.cache` namespace
+- `memoized.cache.snapshot` getter has renamed to `memoized.cache.entries()` method to align with common conventions of `Map`
+  - Returns an array of `[key, value]` pairs to align with common JS conventions and allow direct population of `Map` / `WeakMap`
+- `memoized.options` is now a transparent pass-through of the options provided, instead storing the normalized version
+
+### Enhancements
+
+- Speed improvements
+- Reduction in bundle size
+- Cache manipulation is easier with added methods:
+  - `memoized.cache.delete(key)`
+  - `memoized.cache.get(key)`
+  - `memoized.cache.has(key)`
+  - `memoized.cache.set(key, value)`
+
 ## 4.1.2
 
 - Republish of [#102](https://github.com/planttheidea/micro-memoize/pull/102)

DEV_ONLY/index.ts

@@ -1,12 +1,9 @@
-/* globals document */
-
 /* eslint-disable */
 
 import Bluebird from 'bluebird';
 import { deepEqual } from 'fast-equals';
 
 import memoize from '../src';
-import { Key, RawKey } from '../index.d';
 
 // import '../benchmarks';
 
@@ -42,24 +39,31 @@ memoized(bar, foo);
 memoized(foo, bar);
 memoized(foo, bar);
 
-console.log(memoized.cache.snapshot);
+console.log(memoized.cache.entries());
 console.log(memoized.cache);
 
-memoized.cache.keys = [];
-memoized.cache.values = [];
+memoized.cache.clear();
 
-console.log(memoized.cache.snapshot);
+console.log(memoized.cache.entries());
 console.log(memoized.cache);
 
 console.groupEnd();
 
 console.group('standard with larger cache size');
 
-const memoizedLargerCache = memoize(method, {
-  onCacheChange(cache) {
-    console.log([...cache.keys]);
-  },
-  maxSize: 3,
+const memoizedLargerCache = memoize(memoized, { maxSize: 3 });
+
+memoizedLargerCache.cache.on('add', (event) => {
+  console.log(event);
+});
+memoizedLargerCache.cache.on('delete', (event) => {
+  console.log(event);
+});
+memoizedLargerCache.cache.on('hit', (event) => {
+  console.log(event);
+});
+memoizedLargerCache.cache.on('update', (event) => {
+  console.log(event);
 });
 
 memoizedLargerCache(foo, bar);
@@ -70,17 +74,15 @@ memoizedLargerCache(foo, bar);
 memoizedLargerCache(baz, quz);
 memoizedLargerCache(foo, quz);
 
-console.log(memoizedLargerCache.cache.snapshot);
+console.log(memoizedLargerCache.cache.entries());
 
 console.groupEnd();
 
 console.group('maxArgs');
 
-// limit to testing the first args
-const isMatchingKeyMaxArgs = (originalKey: Key, newKey: RawKey): boolean =>
-  originalKey[0] === newKey[0];
-
-const memoizedMax = memoize(method, { isMatchingKey: isMatchingKeyMaxArgs });
+const memoizedMax = memoize(method, {
+  isKeyEqual: (originalKey, newKey) => originalKey[0] === newKey[0],
+});
 
 memoizedMax(foo, bar);
 memoizedMax(foo, baz);
@@ -103,15 +105,15 @@ const deepEqualMethod = ({
 };
 
 const deepEqualMemoized = memoize(deepEqualMethod, {
-  isEqual: deepEqual,
+  isArgEqual: deepEqual,
 });
 
 deepEqualMemoized({ one: 1, two: 2 });
 deepEqualMemoized({ one: 2, two: 1 });
 deepEqualMemoized({ one: 1, two: 2 });
 deepEqualMemoized({ one: 1, two: 2 });
 
-console.log(deepEqualMemoized.cache.snapshot);
+console.log(deepEqualMemoized.cache.entries());
 
 console.groupEnd();
 
@@ -128,24 +130,24 @@ const promiseMethod = (number: number, otherNumber: number) => {
 const promiseMethodRejected = (number: number) => {
   console.log('promise rejection method fired', number);
 
-  return new Bluebird((resolve, reject) => {
+  return new Bluebird((_resolve, reject) => {
     setTimeout(() => {
       reject(new Error(foo));
     }, 100);
   });
 };
 
-const memoizedPromise = memoize(promiseMethod, { isPromise: true });
+const memoizedPromise = memoize(promiseMethod, { async: true });
 const memoizedPromiseRejected = memoize(promiseMethodRejected, {
-  isPromise: true,
+  async: true,
 });
 
 memoizedPromiseRejected(3)
   .then((value: any) => {
     console.log(value);
   })
   .catch((error: Error) => {
-    console.log(memoizedPromiseRejected.cache.snapshot);
+    console.log(memoizedPromiseRejected.cache.entries());
     console.error(error);
   });
 
@@ -154,7 +156,7 @@ memoizedPromiseRejected(3)
     console.log(value);
   })
   .catch((error: Error) => {
-    console.log(memoizedPromiseRejected.cache.snapshot);
+    console.log(memoizedPromiseRejected.cache.entries());
     console.error(error);
   });
 
@@ -163,7 +165,7 @@ memoizedPromiseRejected(3)
     console.log(value);
   })
   .catch((error: Error) => {
-    console.log(memoizedPromiseRejected.cache.snapshot);
+    console.log(memoizedPromiseRejected.cache.entries());
     console.error(error);
   });
 
@@ -177,7 +179,7 @@ memoizedPromise(2, 2).then((value: unknown) => {
   console.log(`cached value: ${value}`);
 });
 
-console.log(memoizedPromise.cache.snapshot.keys);
+console.log(memoizedPromise.cache.entries().map(([key]) => key));
 
 console.groupEnd();
 
@@ -206,10 +208,10 @@ const noFns = (one: string, two: string, three: Function) => {
 };
 
 const memoizedNoFns = memoize(noFns, {
-  isEqual(key1: string, key2: string) {
+  isArgEqual(key1, key2) {
     return key1 === key2;
   },
-  transformKey(args: any) {
+  transformKey(args) {
     return [JSON.stringify(args)];
   },
 });
@@ -231,7 +233,7 @@ const matchingKeyMethod = function (object: {
 };
 
 const matchingKeyMemoized = memoize(matchingKeyMethod, {
-  isMatchingKey: deepEqual,
+  isKeyEqual: deepEqual,
   maxSize: 10,
 });
 
@@ -299,9 +301,9 @@ const metadata = {
 const result1 = calc(data, metadata);
 
 console.log(result1);
-console.log(calc.cache.snapshot);
+console.log(calc.cache.entries());
 
 const result2 = calc(data, metadata);
 
 console.log(result2);
-console.log(calc.cache.snapshot);
+console.log(calc.cache.entries());