@thi.ng/memoize 4.0.0 → 4.0.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-10-31T22:57:27Z
+- **Last updated**: 2024-11-10T17:11:51Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -30,7 +30,7 @@
 
 ## About
 
-Function memoization with configurable caching.
+Function memoization with configurable caching and support for async functions.
 
 This package provides different function memoization implementations for
 functions with arbitrary arguments and custom result caching using ES6
@@ -48,10 +48,10 @@ based on different strategies. See doc strings for further details.
 - [defOnce()](https://docs.thi.ng/umbrella/memoize/functions/defOnce.html)
 - [delay()](https://docs.thi.ng/umbrella/memoize/functions/delay.html)
 - [doOnce()](https://docs.thi.ng/umbrella/memoize/functions/doOnce.html)
-- [memoize()](https://docs.thi.ng/umbrella/memoize/functions/memoize.html)
-- [memoize1()](https://docs.thi.ng/umbrella/memoize/functions/memoize1.html)
-- [memoizeJ()](https://docs.thi.ng/umbrella/memoize/functions/memoizeJ.html)
-- [memoizeO()](https://docs.thi.ng/umbrella/memoize/functions/memoizeO.html)
+- [memoize()](https://docs.thi.ng/umbrella/memoize/functions/memoize.html) / [memoizeAsync()](https://docs.thi.ng/umbrella/memoize/functions/memoizeAsync.html)
+- [memoize1()](https://docs.thi.ng/umbrella/memoize/functions/memoize1.html) / [memoizeAsync1()](https://docs.thi.ng/umbrella/memoize/functions/memoizeAsync1.html)
+- [memoizeJ()](https://docs.thi.ng/umbrella/memoize/functions/memoizeJ.html) / [memoizeAsyncJ()](https://docs.thi.ng/umbrella/memoize/functions/memoizeAsyncJ.html)
+- [memoizeO()](https://docs.thi.ng/umbrella/memoize/functions/memoizeO.html) / [memoizeAsyncO()](https://docs.thi.ng/umbrella/memoize/functions/memoizeAsyncO.html)
 
 ## Status
 
@@ -126,7 +126,10 @@ import { LRUCache } from "@thi.ng/cache";
 ```ts
 import { memoize1 } from "@thi.ng/memoize";
 
-foo = memoize1((x) => (console.log("exec"), x * 10));
+foo = memoize1((x: number) => {
+    console.log("exec");
+    return x * 10;
+});
 
 foo(1);
 // exec
@@ -138,7 +141,7 @@ import { EquivMap } from "@thi.ng/associative";
 
 // with custom cache
 foo = memoize1(
-    (x) => (console.log("exec"), x[0] * 10),
+    (x: number[]) => (console.log("exec"), x[0] * 10),
     // custom ES6 Map impl which compares by value, not by reference
     new EquivMap()
 );
@@ -148,6 +151,7 @@ foo([1]);
 // 10
 
 // would be a cache miss w/ native ES6 Map
+// due to lack of value equality semantics
 foo([1]);
 // 10
 
@@ -155,7 +159,7 @@ import { LRUCache } from "@thi.ng/cache";
 
 // use LRU cache to limit cache size
 foo = memoize1(
-    (x) => (console.log("exec"), x[0] * 10),
+    (x: number[]) => (console.log("exec"), x[0] * 10),
     new LRUCache(null, { maxlen: 3 })
 );
 ```
@@ -167,7 +171,10 @@ import { memoize } from "@thi.ng/memoize";
 import { EquivMap } from "@thi.ng/associative";
 
 const dotProduct = memoize(
-    (x, y) => (console.log("exec"), x[0] * y[0] + x[1] * y[1]),
+    (x: number[], y: number[]) => {
+        console.log("exec");
+        return x[0] * y[0] + x[1] * y[1];
+    },
     new EquivMap()
 );
 
@@ -184,11 +191,16 @@ dotProduct([1,2], [3,4]);
 import { memoizeJ } from "@thi.ng/memoize";
 
 const dotProduct = memoizeJ(
-    (x, y) => (console.log("exec"), x[0] * y[0] + x[1] * y[1])
+    (x: number[], y: number[]) => {
+        console.log("exec");
+        return x[0] * y[0] + x[1] * y[1];
+    }
 );
+
 dotProduct([1, 2], [3, 4]);
 // exec
 // 11
+
 dotProduct([1, 2], [3, 4]);
 // 11
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thi.ng/memoize",
-  "version": "4.0.0",
-  "description": "Function memoization with configurable caching",
+  "version": "4.0.2",
+  "description": "Function memoization with configurable caching and support for async functions",
   "type": "module",
   "module": "./index.js",
   "typings": "./index.d.ts",
@@ -28,7 +28,7 @@
     "build:decl": "tsc --declaration --emitDeclarationOnly",
     "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
     "clean": "bun ../../tools/src/clean-package.ts",
-    "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
+    "doc": "typedoc --options ../../typedoc.json --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
@@ -36,7 +36,7 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.11"
+    "@thi.ng/api": "^8.11.12"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.9",
@@ -45,6 +45,7 @@
     "typescript": "^5.6.2"
   },
   "keywords": [
+    "async",
     "cache",
     "functional",
     "memoization",
@@ -95,5 +96,5 @@
     ],
     "year": 2018
   },
-  "gitHead": "36d88652f6712b0e7ed8e55d1f4d9b3718294f7f\n"
+  "gitHead": "ef89090bb19fc5bca23be5da8cfce05b82ff4ad1\n"
 }