docs(memoize): update readme & pkg meta

packages/memoize/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,14 +151,15 @@ foo([1]);
 // 10
 
 // would be a cache miss w/ native ES6 Map
+// due to lack of value equality semantics
 foo([1]);
 // 10
 
 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
 ```

packages/memoize/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@thi.ng/memoize",
 	"version": "4.0.0",
-	"description": "Function memoization with configurable caching",
+	"description": "Function memoization with configurable caching and support for async functions",
 	"type": "module",
 	"module": "./index.js",
 	"typings": "./index.d.ts",
@@ -45,6 +45,7 @@
 		"typescript": "^5.6.2"
 	},
 	"keywords": [
+		"async",
 		"cache",
 		"functional",
 		"memoization",

packages/memoize/tpl.readme.md

@@ -22,10 +22,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)
 
 {{meta.status}}
 
@@ -64,7 +64,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
@@ -76,8 +79,8 @@ import { EquivMap } from "@thi.ng/associative";
 
 // with custom cache
 foo = memoize1(
-    (x) => (console.log("exec"), x[0] * 10),
-	// custom ES6 Map impl which compares by value, not by reference
+    (x: number[]) => (console.log("exec"), x[0] * 10),
+    // custom ES6 Map impl which compares by value, not by reference
     new EquivMap()
 );
 
@@ -86,14 +89,15 @@ foo([1]);
 // 10
 
 // would be a cache miss w/ native ES6 Map
+// due to lack of value equality semantics
 foo([1]);
 // 10
 
 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 })
 );
 ```
@@ -105,7 +109,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()
 );
 
@@ -122,11 +129,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
 ```