publish: add (memoize) supports getters

Author: tenbits

lib/memd.js

@@ -1047,12 +1047,21 @@ var memoize_1 = _src_fn_memoize;
 function deco_memoize(opts) {
     return function (target, propertyKey, descriptor) {
         var viaProperty = descriptor == null;
-        var fn = memoize_1.fn_memoize(viaProperty ? target[propertyKey] : descriptor.value, opts, propertyKey);
+        var isGetter = !viaProperty && typeof descriptor.get === 'function';
+        var innerFn = viaProperty
+            ? target[propertyKey]
+            : (isGetter ? descriptor.get : descriptor.value);
+        var fn = memoize_1.fn_memoize(innerFn, opts, propertyKey);
         if (viaProperty) {
             target[propertyKey] = fn;
             return;
         }
-        descriptor.value = fn;
+        if (isGetter) {
+            descriptor.get = fn;
+        }
+        else {
+            descriptor.value = fn;
+        }
         return descriptor;
     };
 }

package.json

@@ -5,7 +5,7 @@
         "name": "Alexander Kit",
         "email": "alex.kit@atmajs.com"
     },
-    "version": "0.3.3",
+    "version": "0.3.5",
     "main": "./lib/memd.js",
     "types": "./lib/memd.d.ts",
     "repository": {
@@ -75,7 +75,8 @@
                 "typescript": {
                     "compilerOptions": {
                         "#if (TEST)": {
-                            "module": "AMD"
+                            "module": "AMD",
+                            "target": "es2020"
                         }
                     }
                 }

readme.md

@@ -15,7 +15,10 @@ import { deco } from 'memd';
 
 class Foo {
     @deco.memoize()
-    foo () {}
+    someMethod () {}
+
+    @deco.memoize()
+    get someProp () {}
 
     @deco.debounce()
     bar () {}
@@ -57,7 +60,12 @@ const cache = new Cache(<ICacheOpts> { maxAge: 60 });
 
 ```ts
 interface IMemoizeOpts {
+    // Per default method or getter returns are cached for all instances of a class.
+    // Use `perInstance` to cache per instance: this could be useful when the method reads `this.` values.
     perInstance?: boolean
+
+    // When a promise is memoized, and gets rejected. Clear also the cache, so that
+    // the next time it wont hit the cache and is reavaluated.
     clearOnReject?: boolean
 }
 .memoize(opts?: ICacheOpts & IMemoizeOpts)

src/deco/memoize.ts

@@ -5,12 +5,22 @@ export function deco_memoize (opts?: ICacheOpts & IMemoizeOpts) {
 
     return function (target, propertyKey, descriptor?) {
         const viaProperty = descriptor == null;
-        const fn = fn_memoize(viaProperty ? target[propertyKey] : descriptor.value, opts, propertyKey);
+        const isGetter = !viaProperty && typeof descriptor.get === 'function';
+
+        const innerFn = viaProperty
+            ? target[propertyKey]
+            : (isGetter ? descriptor.get : descriptor.value);
+
+        const fn = fn_memoize(innerFn, opts, propertyKey);
         if (viaProperty) {
             target[propertyKey] = fn;
             return;
         }
-        descriptor.value = fn;
+        if (isGetter) {
+            descriptor.get = fn;
+        } else {
+            descriptor.value = fn;
+        }
         return descriptor;
     };
-}
+}

test/memoize.spec.ts

@@ -1,7 +1,7 @@
 import { class_EventEmitter } from 'atma-utils'
 import { deco_memoize } from '../src/deco/memoize';
-import sinon = require('sinon');
 import { fn_memoize } from '../src/fn/memoize';
+import * as sinon from 'sinon';
 
 UTest({
     'memoize'() {
@@ -155,6 +155,47 @@ UTest({
         let result3 = await promise3;
         eq_(result3, 3);
     },
+
+    'memoize on properties': {
+        'for all instances' () {
+            class Foo {
+                @deco_memoize()
+                get getFoo () {
+                    return { t: Math.random() };
+                }
+            }
+            let foo = new Foo ();
+            let v1 = foo.getFoo;
+            let v2 = foo.getFoo;
+            eq_(typeof v1.t, 'number');
+            eq_(v1.t, v2.t);
+
+            let foo2 = new Foo()
+            let v21 = foo2.getFoo;
+            eq_(v1.t, v21.t);
+        },
+        'per instance' () {
+            class Foo {
+                @deco_memoize({ perInstance: true })
+                get getFoo () {
+                    return { t: Math.random() };
+                }
+            }
+            let foo = new Foo ();
+            let v1 = foo.getFoo;
+            let v2 = foo.getFoo;
+            eq_(typeof v1.t, 'number');
+            eq_(v1.t, v2.t);
+
+            let foo2 = new Foo()
+            let v21 = foo2.getFoo;
+            let v22 = foo2.getFoo;
+            eq_(typeof v21.t, 'number');
+            eq_(v21.t, v22.t);
+
+            notEq_(v1.t, v21.t);
+        }
+    }
 })
 
 async function wait(ms) {

tsconfig-build.json

@@ -1,4 +1,11 @@
 {
-    "extends": "./tsconfig.json",
-    "files": ["src/export.ts"]
-}
+    "files": ["src/export.ts"],
+    "exclude": ["node_modules"],
+    "compilerOptions": {
+        "outDir": "ts-temp",
+        "declaration": true,
+        "sourceMap": false,
+        "experimentalDecorators": true,
+        "moduleResolution": "node"
+    }
+}

tsconfig.json

@@ -4,6 +4,8 @@
         "outDir": "ts-temp",
         "declaration": true,
         "sourceMap": false,
-        "experimentalDecorators": true
+        "experimentalDecorators": true,
+        "moduleResolution": "node",
+        "target": "ES2020"
     }
 }