@chriscdn/memoize 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/__tests__/memoize.test.ts +1 -0
- package/lib/index.d.ts +9 -14
- package/lib/memoize.cjs +1 -1
- package/lib/memoize.cjs.map +1 -1
- package/lib/memoize.modern.js +1 -1
- package/lib/memoize.modern.js.map +1 -1
- package/lib/memoize.module.js +1 -1
- package/lib/memoize.module.js.map +1 -1
- package/package.json +5 -5
- package/src/index.ts +12 -16
- package/lib/memoize.umd.js +0 -2
- package/lib/memoize.umd.js.map +0 -1
package/README.md
CHANGED
|
@@ -85,6 +85,18 @@ const options = {
|
|
|
85
85
|
};
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
+
## Cache
|
|
89
|
+
|
|
90
|
+
The underlying [quick-lru](https://www.npmjs.com/package/quick-lru) instance can be accessed with the `.cache` property on the memoized function.
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
const add = MemoizeAsync(_add);
|
|
94
|
+
const result = await add(5, 7);
|
|
95
|
+
|
|
96
|
+
console.log(addCachedAsync.cache.size === 1);
|
|
97
|
+
// true
|
|
98
|
+
```
|
|
99
|
+
|
|
88
100
|
## Tests
|
|
89
101
|
|
|
90
102
|
```bash
|
package/lib/index.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import QuickLRU from "quick-lru";
|
|
1
2
|
type Options<T extends any[]> = {
|
|
2
3
|
maxSize: number;
|
|
3
4
|
maxAge?: number;
|
|
@@ -5,14 +6,11 @@ type Options<T extends any[]> = {
|
|
|
5
6
|
};
|
|
6
7
|
/**
|
|
7
8
|
* Memoize a synchronous function.
|
|
8
|
-
*
|
|
9
|
-
* @template {any[]} Args
|
|
10
|
-
* @template {{}} Return
|
|
11
|
-
* @param {(...args: Args) => Return} cb
|
|
12
|
-
* @param {Partial<Options<Args>>} [options={}]
|
|
13
|
-
* @returns {Return, options?: Partial<Options<Args>>) => (...args: Args) => Return}
|
|
14
9
|
*/
|
|
15
|
-
declare const Memoize: <Args extends
|
|
10
|
+
declare const Memoize: <Args extends unknown[], Return>(cb: (...args: Args) => Return, options?: Partial<Options<Args>>) => {
|
|
11
|
+
(...args: Args): Return;
|
|
12
|
+
cache: QuickLRU<string, Return>;
|
|
13
|
+
};
|
|
16
14
|
/**
|
|
17
15
|
* Memoize an asynchronous function.
|
|
18
16
|
*
|
|
@@ -20,12 +18,9 @@ declare const Memoize: <Args extends any[], Return extends {}>(cb: (...args: Arg
|
|
|
20
18
|
* same arguments is only evaluated once. This is controlled by using a
|
|
21
19
|
* semaphore, which forces redundant calls to wait until the first call
|
|
22
20
|
* completes.
|
|
23
|
-
*
|
|
24
|
-
* @template {any[]} Args
|
|
25
|
-
* @template {{}} Return
|
|
26
|
-
* @param {(...args: Args) => Promise<Return>} cb
|
|
27
|
-
* @param {Partial<Options<Args>>} [options={}]
|
|
28
|
-
* @returns {Promise<Return>, options?: Partial<Options<Args>>) => (...args: Args) => Promise<Return>}
|
|
29
21
|
*/
|
|
30
|
-
declare const MemoizeAsync: <Args extends
|
|
22
|
+
declare const MemoizeAsync: <Args extends unknown[], Return>(cb: (...args: Args) => Promise<Return>, options?: Partial<Options<Args>>) => {
|
|
23
|
+
(...args: Args): Promise<Return>;
|
|
24
|
+
cache: QuickLRU<string, Return>;
|
|
25
|
+
};
|
|
31
26
|
export { Memoize, MemoizeAsync };
|
package/lib/memoize.cjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e=require("@chriscdn/promise-semaphore"),r=require("quick-lru");function n(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var t=/*#__PURE__*/n(e),i=/*#__PURE__*/n(r);exports.Memoize=function(e,r){var n,t;void 0===r&&(r={});var
|
|
1
|
+
var e=require("@chriscdn/promise-semaphore"),r=require("quick-lru");function n(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var t=/*#__PURE__*/n(e),i=/*#__PURE__*/n(r);exports.Memoize=function(e,r){var n,t;void 0===r&&(r={});var a=null!=(n=r.maxSize)?n:1e3,u=null!=(t=r.resolver)?t:function(){return JSON.stringify([].slice.call(arguments))},l=new i.default({maxAge:r.maxAge,maxSize:a}),o=function(){var r=[].slice.call(arguments),n=u.apply(void 0,r);if(l.has(n))return l.get(n);var t=e.apply(void 0,r);return l.set(n,t),t};return o.cache=l,o},exports.MemoizeAsync=function(e,r){var n,a;void 0===r&&(r={});var u=r.maxAge,l=null!=(n=r.maxSize)?n:1e3,o=null!=(a=r.resolver)?a:function(){return JSON.stringify([].slice.call(arguments))},c=new t.default,s=new i.default({maxAge:u,maxSize:l}),f=function(){try{var r=[].slice.call(arguments),n=o.apply(void 0,r);return Promise.resolve(s.has(n)?s.get(n):function(t,i){try{var a=Promise.resolve(c.acquire(n)).then(function(){return s.has(n)?s.get(n):Promise.resolve(e.apply(void 0,r)).then(function(e){return s.set(n,e),e})})}catch(e){return i(!0,e)}return a&&a.then?a.then(i.bind(null,!1),i.bind(null,!0)):i(!1,a)}(0,function(e,r){if(c.release(n),e)throw r;return r}))}catch(e){return Promise.reject(e)}};return f.cache=s,f};
|
|
2
2
|
//# sourceMappingURL=memoize.cjs.map
|
package/lib/memoize.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memoize.cjs","sources":["../src/index.ts"],"sourcesContent":["import Semaphore from \"@chriscdn/promise-semaphore\";\nimport QuickLRU from \"quick-lru\";\n\nconst kDefaultMaxSize = 1000;\n\ntype Options<T extends any[]> = {\n maxSize: number;\n maxAge?: number;\n resolver: (...args: T) => string;\n};\n\n/**\n * Memoize a synchronous function.\n
|
|
1
|
+
{"version":3,"file":"memoize.cjs","sources":["../src/index.ts"],"sourcesContent":["import Semaphore from \"@chriscdn/promise-semaphore\";\nimport QuickLRU from \"quick-lru\";\n\nconst kDefaultMaxSize = 1000;\n\ntype Options<T extends any[]> = {\n maxSize: number;\n maxAge?: number;\n resolver: (...args: T) => string;\n};\n\n/**\n * Memoize a synchronous function.\n */\nconst Memoize = <Args extends unknown[], Return>(\n cb: (...args: Args) => Return,\n options: Partial<Options<Args>> = {},\n) => {\n const maxAge: number | undefined = options.maxAge;\n const maxSize = options.maxSize ?? kDefaultMaxSize;\n\n const resolver = options.resolver ??\n ((...args: Args) => JSON.stringify(args));\n\n const cache = new QuickLRU<string, Return>({\n maxAge,\n maxSize,\n });\n\n const memoizedFunction = (...args: Args): Return => {\n const key = resolver(...args);\n\n if (cache.has(key)) {\n return cache.get(key);\n } else {\n const returnValue = cb(...args);\n cache.set(key, returnValue);\n return returnValue;\n }\n };\n\n memoizedFunction.cache = cache;\n\n return memoizedFunction;\n};\n\n/**\n * Memoize an asynchronous function.\n *\n * This differs from the sychronous case by ensuring multiple calls with the\n * same arguments is only evaluated once. This is controlled by using a\n * semaphore, which forces redundant calls to wait until the first call\n * completes.\n */\nconst MemoizeAsync = <Args extends unknown[], Return>(\n cb: (...args: Args) => Promise<Return>,\n options: Partial<Options<Args>> = {},\n) => {\n const maxAge: number | undefined = options.maxAge;\n const maxSize = options.maxSize ?? kDefaultMaxSize;\n\n const resolver = options.resolver ??\n ((...args: Args) => JSON.stringify(args));\n\n const semaphore = new Semaphore();\n\n const cache = new QuickLRU<string, Return>({\n maxAge,\n maxSize,\n });\n\n const memoizedFunction = async (...args: Args): Promise<Return> => {\n const key = resolver(...args);\n\n if (cache.has(key)) {\n return cache.get(key)!;\n } else {\n try {\n await semaphore.acquire(key);\n\n if (cache.has(key)) {\n return cache.get(key);\n } else {\n const returnValue = await cb(...args);\n cache.set(key, returnValue);\n return returnValue;\n }\n } finally {\n semaphore.release(key);\n }\n }\n };\n\n memoizedFunction.cache = cache;\n\n return memoizedFunction;\n};\n\nexport { Memoize, MemoizeAsync };\n"],"names":["cb","options","_options$maxSize","_options$resolver","maxSize","resolver","JSON","stringify","slice","call","arguments","cache","QuickLRU","maxAge","memoizedFunction","args","key","apply","has","get","returnValue","set","_options$maxSize2","_options$resolver2","semaphore","Semaphore","_arguments","Promise","resolve","acquire","then","_finallyRethrows","_wasThrown","_result","release","e","reject"],"mappings":"wMAcgB,SACZA,EACAC,GACAC,IAAAA,EAAAC,OADAF,IAAAA,IAAAA,EAAkC,CAAA,GAElC,IACMG,EAAyB,OAAlBF,EAAGD,EAAQG,SAAOF,EAhBX,IAkBdG,EAA2B,OAAnBF,EAAGF,EAAQI,UAAQF,EAC5B,WAAmB,OAAAG,KAAKC,UAAS,GAAAC,MAAAC,KAAAC,WAAM,EAEtCC,EAAQ,IAAIC,EAAAA,QAAyB,CACvCC,OAP+BZ,EAAQY,OAQvCT,QAAAA,IAGEU,EAAmB,WAAI,IAAAC,EAAUP,GAAAA,MAAAC,KAAAC,WAC7BM,EAAMX,EAAQY,WAAIF,EAAAA,GAExB,GAAIJ,EAAMO,IAAIF,GACV,OAAOL,EAAMQ,IAAIH,GAEjB,IAAMI,EAAcpB,EAAEiB,WAAIF,EAAAA,GAE1B,OADAJ,EAAMU,IAAIL,EAAKI,GACRA,CAEf,EAIA,OAFAN,EAAiBH,MAAQA,EAElBG,CACX,uBAUqB,SACjBd,EACAC,GACAqB,IAAAA,EAAAC,OADAtB,IAAAA,IAAAA,EAAkC,CAAE,GAEpC,IAAMY,EAA6BZ,EAAQY,OACrCT,EAAyBkB,OAAlBA,EAAGrB,EAAQG,SAAOkB,EAxDX,IA0DdjB,EAA2BkB,OAAnBA,EAAGtB,EAAQI,UAAQkB,EAC5B,WAAmB,OAAAjB,KAAKC,UAAS,GAAAC,MAAAC,KAAAC,WAAM,EAEtCc,EAAY,IAAIC,EAAW,QAE3Bd,EAAQ,IAAIC,EAAAA,QAAyB,CACvCC,OAAAA,EACAT,QAAAA,IAGEU,EAAA,eAA4DY,IAA/BX,EAAU,GAAAP,MAAAC,KAAqBC,WACxDM,EAAMX,EAAQY,WAAIF,EAAAA,GAAM,OAAAY,QAAAC,QAE1BjB,EAAMO,IAAIF,GACHL,EAAMQ,IAAIH,2BAEbW,QAAAC,QACMJ,EAAUK,QAAQb,IAAIc,KAAA,WAAA,OAExBnB,EAAMO,IAAIF,GACHL,EAAMQ,IAAIH,GAAKW,QAAAC,QAEI5B,EAAEiB,WAAIF,EAAAA,IAAKe,KAAA,SAA/BV,GAEN,OADAT,EAAMU,IAAIL,EAAKI,GACRA,CAAY,EAE1B,4FAZsBW,CAEnB,EAUHC,SAAAA,EAAAC,GAC0B,GAAvBT,EAAUU,QAAQlB,GAAKgB,EAAA,MAAAC,EAAA,OAAAA,CAAA,GAGnC,CAAC,MAAAE,GAAA,OAAAR,QAAAS,OAAAD,EAEDrB,CAAAA,EAEA,OAFAA,EAAiBH,MAAQA,EAElBG,CACX"}
|
package/lib/memoize.modern.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import e from"@chriscdn/promise-semaphore";import r from"quick-lru";const t=(e,t={})=>{var n,a;const s=null!=(n=t.maxSize)?n:1e3,i=null!=(a=t.resolver)?a:(...e)=>JSON.stringify(e),
|
|
1
|
+
import e from"@chriscdn/promise-semaphore";import r from"quick-lru";const t=(e,t={})=>{var n,a;const s=null!=(n=t.maxSize)?n:1e3,i=null!=(a=t.resolver)?a:(...e)=>JSON.stringify(e),c=new r({maxAge:t.maxAge,maxSize:s}),o=(...r)=>{const t=i(...r);if(c.has(t))return c.get(t);{const n=e(...r);return c.set(t,n),n}};return o.cache=c,o},n=(t,n={})=>{var a,s;const i=n.maxAge,c=null!=(a=n.maxSize)?a:1e3,o=null!=(s=n.resolver)?s:(...e)=>JSON.stringify(e),l=new e,m=new r({maxAge:i,maxSize:c}),u=async(...e)=>{const r=o(...e);if(m.has(r))return m.get(r);try{if(await l.acquire(r),m.has(r))return m.get(r);{const n=await t(...e);return m.set(r,n),n}}finally{l.release(r)}};return u.cache=m,u};export{t as Memoize,n as MemoizeAsync};
|
|
2
2
|
//# sourceMappingURL=memoize.modern.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memoize.modern.js","sources":["../src/index.ts"],"sourcesContent":["import Semaphore from \"@chriscdn/promise-semaphore\";\nimport QuickLRU from \"quick-lru\";\n\nconst kDefaultMaxSize = 1000;\n\ntype Options<T extends any[]> = {\n maxSize: number;\n maxAge?: number;\n resolver: (...args: T) => string;\n};\n\n/**\n * Memoize a synchronous function.\n
|
|
1
|
+
{"version":3,"file":"memoize.modern.js","sources":["../src/index.ts"],"sourcesContent":["import Semaphore from \"@chriscdn/promise-semaphore\";\nimport QuickLRU from \"quick-lru\";\n\nconst kDefaultMaxSize = 1000;\n\ntype Options<T extends any[]> = {\n maxSize: number;\n maxAge?: number;\n resolver: (...args: T) => string;\n};\n\n/**\n * Memoize a synchronous function.\n */\nconst Memoize = <Args extends unknown[], Return>(\n cb: (...args: Args) => Return,\n options: Partial<Options<Args>> = {},\n) => {\n const maxAge: number | undefined = options.maxAge;\n const maxSize = options.maxSize ?? kDefaultMaxSize;\n\n const resolver = options.resolver ??\n ((...args: Args) => JSON.stringify(args));\n\n const cache = new QuickLRU<string, Return>({\n maxAge,\n maxSize,\n });\n\n const memoizedFunction = (...args: Args): Return => {\n const key = resolver(...args);\n\n if (cache.has(key)) {\n return cache.get(key);\n } else {\n const returnValue = cb(...args);\n cache.set(key, returnValue);\n return returnValue;\n }\n };\n\n memoizedFunction.cache = cache;\n\n return memoizedFunction;\n};\n\n/**\n * Memoize an asynchronous function.\n *\n * This differs from the sychronous case by ensuring multiple calls with the\n * same arguments is only evaluated once. This is controlled by using a\n * semaphore, which forces redundant calls to wait until the first call\n * completes.\n */\nconst MemoizeAsync = <Args extends unknown[], Return>(\n cb: (...args: Args) => Promise<Return>,\n options: Partial<Options<Args>> = {},\n) => {\n const maxAge: number | undefined = options.maxAge;\n const maxSize = options.maxSize ?? kDefaultMaxSize;\n\n const resolver = options.resolver ??\n ((...args: Args) => JSON.stringify(args));\n\n const semaphore = new Semaphore();\n\n const cache = new QuickLRU<string, Return>({\n maxAge,\n maxSize,\n });\n\n const memoizedFunction = async (...args: Args): Promise<Return> => {\n const key = resolver(...args);\n\n if (cache.has(key)) {\n return cache.get(key)!;\n } else {\n try {\n await semaphore.acquire(key);\n\n if (cache.has(key)) {\n return cache.get(key);\n } else {\n const returnValue = await cb(...args);\n cache.set(key, returnValue);\n return returnValue;\n }\n } finally {\n semaphore.release(key);\n }\n }\n };\n\n memoizedFunction.cache = cache;\n\n return memoizedFunction;\n};\n\nexport { Memoize, MemoizeAsync };\n"],"names":["Memoize","cb","options","_options$maxSize","_options$resolver","maxSize","resolver","args","JSON","stringify","cache","QuickLRU","maxAge","memoizedFunction","key","has","get","returnValue","set","MemoizeAsync","_options$maxSize2","_options$resolver2","semaphore","Semaphore","async","acquire","release"],"mappings":"oEAGA,MAWMA,EAAUA,CACZC,EACAC,EAAkC,CAAA,KAClC,IAAAC,EAAAC,EACA,MACMC,SAAOF,EAAGD,EAAQG,SAAOF,EAhBX,IAkBdG,EAA2B,OAAnBF,EAAGF,EAAQI,UAAQF,EAC5B,IAAIG,IAAeC,KAAKC,UAAUF,GAEjCG,EAAQ,IAAIC,EAAyB,CACvCC,OAP+BV,EAAQU,OAQvCP,YAGEQ,EAAmBA,IAAIN,KACzB,MAAMO,EAAMR,KAAYC,GAExB,GAAIG,EAAMK,IAAID,GACV,OAAOJ,EAAMM,IAAIF,GACd,CACH,MAAMG,EAAchB,KAAMM,GAE1B,OADAG,EAAMQ,IAAIJ,EAAKG,GACRA,CACV,GAKL,OAFAJ,EAAiBH,MAAQA,EAElBG,GAWLM,EAAeA,CACjBlB,EACAC,EAAkC,CAAA,KAClC,IAAAkB,EAAAC,EACA,MAAMT,EAA6BV,EAAQU,OACrCP,EAAyBe,OAAlBA,EAAGlB,EAAQG,SAAOe,EAxDX,IA0Ddd,SAAQe,EAAGnB,EAAQI,UAAQe,EAC5B,IAAId,IAAeC,KAAKC,UAAUF,GAEjCe,EAAY,IAAIC,EAEhBb,EAAQ,IAAIC,EAAyB,CACvCC,SACAP,YAGEQ,EAAmBW,SAAUjB,KAC/B,MAAMO,EAAMR,KAAYC,GAExB,GAAIG,EAAMK,IAAID,GACV,OAAOJ,EAAMM,IAAIF,GAEjB,IAGI,SAFMQ,EAAUG,QAAQX,GAEpBJ,EAAMK,IAAID,GACV,OAAOJ,EAAMM,IAAIF,GACd,CACH,MAAMG,QAAoBhB,KAAMM,GAEhC,OADAG,EAAMQ,IAAIJ,EAAKG,GACRA,CACV,CACJ,CAAA,QACGK,EAAUI,QAAQZ,EACrB,CACJ,EAKL,OAFAD,EAAiBH,MAAQA,EAElBG"}
|
package/lib/memoize.module.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import e from"@chriscdn/promise-semaphore";import r from"quick-lru";var n=function(e,n){var t,i;void 0===n&&(n={});var
|
|
1
|
+
import e from"@chriscdn/promise-semaphore";import r from"quick-lru";var n=function(e,n){var t,i;void 0===n&&(n={});var a=null!=(t=n.maxSize)?t:1e3,l=null!=(i=n.resolver)?i:function(){return JSON.stringify([].slice.call(arguments))},o=new r({maxAge:n.maxAge,maxSize:a}),u=function(){var r=[].slice.call(arguments),n=l.apply(void 0,r);if(o.has(n))return o.get(n);var t=e.apply(void 0,r);return o.set(n,t),t};return u.cache=o,u},t=function(n,t){var i,a;void 0===t&&(t={});var l=t.maxAge,o=null!=(i=t.maxSize)?i:1e3,u=null!=(a=t.resolver)?a:function(){return JSON.stringify([].slice.call(arguments))},c=new e,s=new r({maxAge:l,maxSize:o}),v=function(){try{var e=[].slice.call(arguments),r=u.apply(void 0,e);return Promise.resolve(s.has(r)?s.get(r):function(t,i){try{var a=Promise.resolve(c.acquire(r)).then(function(){return s.has(r)?s.get(r):Promise.resolve(n.apply(void 0,e)).then(function(e){return s.set(r,e),e})})}catch(e){return i(!0,e)}return a&&a.then?a.then(i.bind(null,!1),i.bind(null,!0)):i(!1,a)}(0,function(e,n){if(c.release(r),e)throw n;return n}))}catch(e){return Promise.reject(e)}};return v.cache=s,v};export{n as Memoize,t as MemoizeAsync};
|
|
2
2
|
//# sourceMappingURL=memoize.module.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memoize.module.js","sources":["../src/index.ts"],"sourcesContent":["import Semaphore from \"@chriscdn/promise-semaphore\";\nimport QuickLRU from \"quick-lru\";\n\nconst kDefaultMaxSize = 1000;\n\ntype Options<T extends any[]> = {\n maxSize: number;\n maxAge?: number;\n resolver: (...args: T) => string;\n};\n\n/**\n * Memoize a synchronous function.\n
|
|
1
|
+
{"version":3,"file":"memoize.module.js","sources":["../src/index.ts"],"sourcesContent":["import Semaphore from \"@chriscdn/promise-semaphore\";\nimport QuickLRU from \"quick-lru\";\n\nconst kDefaultMaxSize = 1000;\n\ntype Options<T extends any[]> = {\n maxSize: number;\n maxAge?: number;\n resolver: (...args: T) => string;\n};\n\n/**\n * Memoize a synchronous function.\n */\nconst Memoize = <Args extends unknown[], Return>(\n cb: (...args: Args) => Return,\n options: Partial<Options<Args>> = {},\n) => {\n const maxAge: number | undefined = options.maxAge;\n const maxSize = options.maxSize ?? kDefaultMaxSize;\n\n const resolver = options.resolver ??\n ((...args: Args) => JSON.stringify(args));\n\n const cache = new QuickLRU<string, Return>({\n maxAge,\n maxSize,\n });\n\n const memoizedFunction = (...args: Args): Return => {\n const key = resolver(...args);\n\n if (cache.has(key)) {\n return cache.get(key);\n } else {\n const returnValue = cb(...args);\n cache.set(key, returnValue);\n return returnValue;\n }\n };\n\n memoizedFunction.cache = cache;\n\n return memoizedFunction;\n};\n\n/**\n * Memoize an asynchronous function.\n *\n * This differs from the sychronous case by ensuring multiple calls with the\n * same arguments is only evaluated once. This is controlled by using a\n * semaphore, which forces redundant calls to wait until the first call\n * completes.\n */\nconst MemoizeAsync = <Args extends unknown[], Return>(\n cb: (...args: Args) => Promise<Return>,\n options: Partial<Options<Args>> = {},\n) => {\n const maxAge: number | undefined = options.maxAge;\n const maxSize = options.maxSize ?? kDefaultMaxSize;\n\n const resolver = options.resolver ??\n ((...args: Args) => JSON.stringify(args));\n\n const semaphore = new Semaphore();\n\n const cache = new QuickLRU<string, Return>({\n maxAge,\n maxSize,\n });\n\n const memoizedFunction = async (...args: Args): Promise<Return> => {\n const key = resolver(...args);\n\n if (cache.has(key)) {\n return cache.get(key)!;\n } else {\n try {\n await semaphore.acquire(key);\n\n if (cache.has(key)) {\n return cache.get(key);\n } else {\n const returnValue = await cb(...args);\n cache.set(key, returnValue);\n return returnValue;\n }\n } finally {\n semaphore.release(key);\n }\n }\n };\n\n memoizedFunction.cache = cache;\n\n return memoizedFunction;\n};\n\nexport { Memoize, MemoizeAsync };\n"],"names":["Memoize","cb","options","_options$maxSize","_options$resolver","maxSize","resolver","JSON","stringify","slice","call","arguments","cache","QuickLRU","maxAge","memoizedFunction","args","key","apply","has","get","returnValue","set","MemoizeAsync","_options$maxSize2","_options$resolver2","semaphore","Semaphore","_arguments","Promise","resolve","acquire","then","_finallyRethrows","_wasThrown","_result","release","e","reject"],"mappings":"oEAGA,IAWMA,EAAU,SACZC,EACAC,GACAC,IAAAA,EAAAC,OADAF,IAAAA,IAAAA,EAAkC,CAAA,GAElC,IACMG,EAAyB,OAAlBF,EAAGD,EAAQG,SAAOF,EAhBX,IAkBdG,EAA2B,OAAnBF,EAAGF,EAAQI,UAAQF,EAC5B,WAAmB,OAAAG,KAAKC,UAAS,GAAAC,MAAAC,KAAAC,WAAM,EAEtCC,EAAQ,IAAIC,EAAyB,CACvCC,OAP+BZ,EAAQY,OAQvCT,QAAAA,IAGEU,EAAmB,WAAI,IAAAC,EAAUP,GAAAA,MAAAC,KAAAC,WAC7BM,EAAMX,EAAQY,WAAIF,EAAAA,GAExB,GAAIJ,EAAMO,IAAIF,GACV,OAAOL,EAAMQ,IAAIH,GAEjB,IAAMI,EAAcpB,EAAEiB,WAAIF,EAAAA,GAE1B,OADAJ,EAAMU,IAAIL,EAAKI,GACRA,CAEf,EAIA,OAFAN,EAAiBH,MAAQA,EAElBG,CACX,EAUMQ,EAAe,SACjBtB,EACAC,GACAsB,IAAAA,EAAAC,OADAvB,IAAAA,IAAAA,EAAkC,CAAE,GAEpC,IAAMY,EAA6BZ,EAAQY,OACrCT,EAAyBmB,OAAlBA,EAAGtB,EAAQG,SAAOmB,EAxDX,IA0DdlB,EAA2BmB,OAAnBA,EAAGvB,EAAQI,UAAQmB,EAC5B,WAAmB,OAAAlB,KAAKC,UAAS,GAAAC,MAAAC,KAAAC,WAAM,EAEtCe,EAAY,IAAIC,EAEhBf,EAAQ,IAAIC,EAAyB,CACvCC,OAAAA,EACAT,QAAAA,IAGEU,EAAA,eAA4Da,IAA/BZ,EAAU,GAAAP,MAAAC,KAAqBC,WACxDM,EAAMX,EAAQY,WAAIF,EAAAA,GAAM,OAAAa,QAAAC,QAE1BlB,EAAMO,IAAIF,GACHL,EAAMQ,IAAIH,2BAEbY,QAAAC,QACMJ,EAAUK,QAAQd,IAAIe,KAAA,WAAA,OAExBpB,EAAMO,IAAIF,GACHL,EAAMQ,IAAIH,GAAKY,QAAAC,QAEI7B,EAAEiB,WAAIF,EAAAA,IAAKgB,KAAA,SAA/BX,GAEN,OADAT,EAAMU,IAAIL,EAAKI,GACRA,CAAY,EAE1B,4FAZsBY,CAEnB,EAUHC,SAAAA,EAAAC,GAC0B,GAAvBT,EAAUU,QAAQnB,GAAKiB,EAAA,MAAAC,EAAA,OAAAA,CAAA,GAGnC,CAAC,MAAAE,GAAA,OAAAR,QAAAS,OAAAD,EAEDtB,CAAAA,EAEA,OAFAA,EAAiBH,MAAQA,EAElBG,CACX"}
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@chriscdn/memoize",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Memoize a synchronous or asynchronous function.",
|
|
5
5
|
"repository": "https://github.com/chriscdn/memoize",
|
|
6
6
|
"author": "Christopher Meyer <chris@schwiiz.org>",
|
|
7
7
|
"license": "MIT",
|
|
8
8
|
"type": "module",
|
|
9
|
-
"source": "src/index.ts",
|
|
9
|
+
"source": "./src/index.ts",
|
|
10
10
|
"exports": {
|
|
11
11
|
"types": "./lib/index.d.ts",
|
|
12
12
|
"require": "./lib/memoize.cjs",
|
|
@@ -14,10 +14,10 @@
|
|
|
14
14
|
},
|
|
15
15
|
"main": "./lib/memoize.cjs",
|
|
16
16
|
"module": "./lib/memoize.module.js",
|
|
17
|
-
"
|
|
17
|
+
"__unpkg": "./lib/memoize.umd.js",
|
|
18
18
|
"types": "./lib/index.d.ts",
|
|
19
19
|
"scripts": {
|
|
20
|
-
"build": "rm -rf ./lib/ && microbundle",
|
|
20
|
+
"build": "rm -rf ./lib/ && microbundle --format modern,esm,cjs",
|
|
21
21
|
"dev": "microbundle watch",
|
|
22
22
|
"test": "vitest"
|
|
23
23
|
},
|
|
@@ -27,6 +27,6 @@
|
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"microbundle": "^0.15.1",
|
|
30
|
-
"vitest": "^2.1.
|
|
30
|
+
"vitest": "^2.1.8"
|
|
31
31
|
}
|
|
32
32
|
}
|
package/src/index.ts
CHANGED
|
@@ -11,14 +11,8 @@ type Options<T extends any[]> = {
|
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
13
|
* Memoize a synchronous function.
|
|
14
|
-
*
|
|
15
|
-
* @template {any[]} Args
|
|
16
|
-
* @template {{}} Return
|
|
17
|
-
* @param {(...args: Args) => Return} cb
|
|
18
|
-
* @param {Partial<Options<Args>>} [options={}]
|
|
19
|
-
* @returns {Return, options?: Partial<Options<Args>>) => (...args: Args) => Return}
|
|
20
14
|
*/
|
|
21
|
-
const Memoize = <Args extends
|
|
15
|
+
const Memoize = <Args extends unknown[], Return>(
|
|
22
16
|
cb: (...args: Args) => Return,
|
|
23
17
|
options: Partial<Options<Args>> = {},
|
|
24
18
|
) => {
|
|
@@ -33,7 +27,7 @@ const Memoize = <Args extends any[], Return extends {}>(
|
|
|
33
27
|
maxSize,
|
|
34
28
|
});
|
|
35
29
|
|
|
36
|
-
|
|
30
|
+
const memoizedFunction = (...args: Args): Return => {
|
|
37
31
|
const key = resolver(...args);
|
|
38
32
|
|
|
39
33
|
if (cache.has(key)) {
|
|
@@ -44,6 +38,10 @@ const Memoize = <Args extends any[], Return extends {}>(
|
|
|
44
38
|
return returnValue;
|
|
45
39
|
}
|
|
46
40
|
};
|
|
41
|
+
|
|
42
|
+
memoizedFunction.cache = cache;
|
|
43
|
+
|
|
44
|
+
return memoizedFunction;
|
|
47
45
|
};
|
|
48
46
|
|
|
49
47
|
/**
|
|
@@ -53,14 +51,8 @@ const Memoize = <Args extends any[], Return extends {}>(
|
|
|
53
51
|
* same arguments is only evaluated once. This is controlled by using a
|
|
54
52
|
* semaphore, which forces redundant calls to wait until the first call
|
|
55
53
|
* completes.
|
|
56
|
-
*
|
|
57
|
-
* @template {any[]} Args
|
|
58
|
-
* @template {{}} Return
|
|
59
|
-
* @param {(...args: Args) => Promise<Return>} cb
|
|
60
|
-
* @param {Partial<Options<Args>>} [options={}]
|
|
61
|
-
* @returns {Promise<Return>, options?: Partial<Options<Args>>) => (...args: Args) => Promise<Return>}
|
|
62
54
|
*/
|
|
63
|
-
const MemoizeAsync = <Args extends
|
|
55
|
+
const MemoizeAsync = <Args extends unknown[], Return>(
|
|
64
56
|
cb: (...args: Args) => Promise<Return>,
|
|
65
57
|
options: Partial<Options<Args>> = {},
|
|
66
58
|
) => {
|
|
@@ -77,7 +69,7 @@ const MemoizeAsync = <Args extends any[], Return extends {}>(
|
|
|
77
69
|
maxSize,
|
|
78
70
|
});
|
|
79
71
|
|
|
80
|
-
|
|
72
|
+
const memoizedFunction = async (...args: Args): Promise<Return> => {
|
|
81
73
|
const key = resolver(...args);
|
|
82
74
|
|
|
83
75
|
if (cache.has(key)) {
|
|
@@ -98,6 +90,10 @@ const MemoizeAsync = <Args extends any[], Return extends {}>(
|
|
|
98
90
|
}
|
|
99
91
|
}
|
|
100
92
|
};
|
|
93
|
+
|
|
94
|
+
memoizedFunction.cache = cache;
|
|
95
|
+
|
|
96
|
+
return memoizedFunction;
|
|
101
97
|
};
|
|
102
98
|
|
|
103
99
|
export { Memoize, MemoizeAsync };
|
package/lib/memoize.umd.js
DELETED
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
!function(e,r){"object"==typeof exports&&"undefined"!=typeof module?r(exports,require("@chriscdn/promise-semaphore"),require("quick-lru")):"function"==typeof define&&define.amd?define(["exports","@chriscdn/promise-semaphore","quick-lru"],r):r((e||self).memoize={},e.Semaphore,e.quickLru)}(this,function(e,r,n){function i(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var t=/*#__PURE__*/i(r),o=/*#__PURE__*/i(n);e.Memoize=function(e,r){var n,i;void 0===r&&(r={});var t=null!=(n=r.maxSize)?n:1e3,u=null!=(i=r.resolver)?i:function(){return JSON.stringify([].slice.call(arguments))},l=new o.default({maxAge:r.maxAge,maxSize:t});return function(){var r=[].slice.call(arguments),n=u.apply(void 0,r);if(l.has(n))return l.get(n);var i=e.apply(void 0,r);return l.set(n,i),i}},e.MemoizeAsync=function(e,r){var n,i;void 0===r&&(r={});var u=r.maxAge,l=null!=(n=r.maxSize)?n:1e3,a=null!=(i=r.resolver)?i:function(){return JSON.stringify([].slice.call(arguments))},c=new t.default,s=new o.default({maxAge:u,maxSize:l});return function(){try{var r=[].slice.call(arguments),n=a.apply(void 0,r);return Promise.resolve(s.has(n)?s.get(n):function(i,t){try{var o=Promise.resolve(c.acquire(n)).then(function(){return s.has(n)?s.get(n):Promise.resolve(e.apply(void 0,r)).then(function(e){return s.set(n,e),e})})}catch(e){return t(!0,e)}return o&&o.then?o.then(t.bind(null,!1),t.bind(null,!0)):t(!1,o)}(0,function(e,r){if(c.release(n),e)throw r;return r}))}catch(e){return Promise.reject(e)}}}});
|
|
2
|
-
//# sourceMappingURL=memoize.umd.js.map
|
package/lib/memoize.umd.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"memoize.umd.js","sources":["../src/index.ts"],"sourcesContent":["import Semaphore from \"@chriscdn/promise-semaphore\";\nimport QuickLRU from \"quick-lru\";\n\nconst kDefaultMaxSize = 1000;\n\ntype Options<T extends any[]> = {\n maxSize: number;\n maxAge?: number;\n resolver: (...args: T) => string;\n};\n\n/**\n * Memoize a synchronous function.\n *\n * @template {any[]} Args\n * @template {{}} Return\n * @param {(...args: Args) => Return} cb\n * @param {Partial<Options<Args>>} [options={}]\n * @returns {Return, options?: Partial<Options<Args>>) => (...args: Args) => Return}\n */\nconst Memoize = <Args extends any[], Return extends {}>(\n cb: (...args: Args) => Return,\n options: Partial<Options<Args>> = {},\n) => {\n const maxAge: number | undefined = options.maxAge;\n const maxSize = options.maxSize ?? kDefaultMaxSize;\n\n const resolver = options.resolver ??\n ((...args: Args) => JSON.stringify(args));\n\n const cache = new QuickLRU<string, Return>({\n maxAge,\n maxSize,\n });\n\n return (...args: Args): Return => {\n const key = resolver(...args);\n\n if (cache.has(key)) {\n return cache.get(key);\n } else {\n const returnValue = cb(...args);\n cache.set(key, returnValue);\n return returnValue;\n }\n };\n};\n\n/**\n * Memoize an asynchronous function.\n *\n * This differs from the sychronous case by ensuring multiple calls with the\n * same arguments is only evaluated once. This is controlled by using a\n * semaphore, which forces redundant calls to wait until the first call\n * completes.\n *\n * @template {any[]} Args\n * @template {{}} Return\n * @param {(...args: Args) => Promise<Return>} cb\n * @param {Partial<Options<Args>>} [options={}]\n * @returns {Promise<Return>, options?: Partial<Options<Args>>) => (...args: Args) => Promise<Return>}\n */\nconst MemoizeAsync = <Args extends any[], Return extends {}>(\n cb: (...args: Args) => Promise<Return>,\n options: Partial<Options<Args>> = {},\n) => {\n const maxAge: number | undefined = options.maxAge;\n const maxSize = options.maxSize ?? kDefaultMaxSize;\n\n const resolver = options.resolver ??\n ((...args: Args) => JSON.stringify(args));\n\n const semaphore = new Semaphore();\n\n const cache = new QuickLRU<string, Return>({\n maxAge,\n maxSize,\n });\n\n return async (...args: Args): Promise<Return> => {\n const key = resolver(...args);\n\n if (cache.has(key)) {\n return cache.get(key)!;\n } else {\n try {\n await semaphore.acquire(key);\n\n if (cache.has(key)) {\n return cache.get(key);\n } else {\n const returnValue = await cb(...args);\n cache.set(key, returnValue);\n return returnValue;\n }\n } finally {\n semaphore.release(key);\n }\n }\n };\n};\n\nexport { Memoize, MemoizeAsync };\n"],"names":["cb","options","_options$maxSize","_options$resolver","maxSize","resolver","JSON","stringify","slice","call","arguments","cache","QuickLRU","maxAge","args","key","apply","has","get","returnValue","set","_options$maxSize2","_options$resolver2","semaphore","Semaphore","_arguments","Promise","resolve","acquire","then","_finallyRethrows","_wasThrown","_result","release","e","reject"],"mappings":"geAoBgB,SACZA,EACAC,GACA,IAAAC,EAAAC,OADkC,IAAlCF,IAAAA,EAAkC,CAAA,GAElC,IACMG,EAAyB,OAAlBF,EAAGD,EAAQG,SAAOF,EAtBX,IAwBdG,EAA2B,OAAnBF,EAAGF,EAAQI,UAAQF,EAC5B,WAAmB,OAAAG,KAAKC,UAASC,GAAAA,MAAAC,KAAAC,WAAM,EAEtCC,EAAQ,IAAIC,EAAQ,QAAiB,CACvCC,OAP+BZ,EAAQY,OAQvCT,QAAAA,IAGJ,kBAAW,IAAAU,EAAU,GAAAN,MAAAC,KAAAC,WACXK,EAAMV,EAAQW,WAAA,EAAIF,GAExB,GAAIH,EAAMM,IAAIF,GACV,OAAOJ,EAAMO,IAAIH,GAEjB,IAAMI,EAAcnB,EAAEgB,WAAIF,EAAAA,GAE1B,OADAH,EAAMS,IAAIL,EAAKI,GACRA,CAEf,CACJ,iBAgBqB,SACjBnB,EACAC,GACA,IAAAoB,EAAAC,OADkC,IAAlCrB,IAAAA,EAAkC,CAAE,GAEpC,IAAMY,EAA6BZ,EAAQY,OACrCT,EAAyB,OAAlBiB,EAAGpB,EAAQG,SAAOiB,EAhEX,IAkEdhB,EAA2B,OAAnBiB,EAAGrB,EAAQI,UAAQiB,EAC5B,WAAA,OAAmBhB,KAAKC,UAASC,GAAAA,MAAAC,KAAAC,WAAM,EAEtCa,EAAY,IAAIC,EAAW,QAE3Bb,EAAQ,IAAIC,EAAQ,QAAiB,CACvCC,OAAAA,EACAT,QAAAA,IAGJ,OAAA,WAAA,IAAgDqB,IAA/BX,EAAU,GAAAN,MAAAC,KAAqBC,WACtCK,EAAMV,EAAQW,WAAIF,EAAAA,GAAM,OAAAY,QAAAC,QAE1BhB,EAAMM,IAAIF,GACHJ,EAAMO,IAAIH,2BAEbW,QAAAC,QACMJ,EAAUK,QAAQb,IAAIc,KAAA,WAAA,OAExBlB,EAAMM,IAAIF,GACHJ,EAAMO,IAAIH,GAAKW,QAAAC,QAEI3B,EAAEgB,WAAIF,EAAAA,IAAKe,KAAA,SAA/BV,GAEN,OADAR,EAAMS,IAAIL,EAAKI,GACRA,CAAY,EAE1B,4FAZsBW,CAEnB,EAUHC,SAAAA,EAAAC,GAC0B,GAAvBT,EAAUU,QAAQlB,GAAKgB,EAAAC,MAAAA,EAAAA,OAAAA,CAAA,GAGnC,CAAC,MAAAE,GAAAR,OAAAA,QAAAS,OAAAD,EACL,CAAA,CAAA"}
|