koatty_cacheable 1.3.2 → 1.3.7

package/.rollup.config.js

@@ -0,0 +1,63 @@
+/*
+ * @Description: 
+ * @Usage: 
+ * @Author: richen
+ * @Date: 2021-12-17 10:20:44
+ * @LastEditTime: 2021-12-18 11:58:46
+ */
+import json from "@rollup/plugin-json";
+import typescript from 'rollup-plugin-typescript2';
+// import babel from '@rollup/plugin-babel';
+
+export default [
+    {
+        input: './src/index.ts',
+        output: [{
+            format: 'cjs',
+            file: './dist/index.js',
+            banner: require('./scripts/copyright')
+        }],
+        plugins: [
+            // babel({
+            //     babelHelpers: "runtime",
+            //     configFile: './babel.config.js',
+            //     exclude: 'node_modules/**',
+            // }),
+            json(),
+            typescript({
+                tsconfigOverride: {
+                    compilerOptions: {
+                        declaration: false,
+                        declarationMap: false,
+                        module: "ESNext"
+                    }
+                }
+            })
+        ]
+    },
+    {
+        input: './src/index.ts',
+        output: [{
+            format: 'es',
+            file: './dist/index.mjs',
+            banner: require('./scripts/copyright')
+        }],
+        plugins: [
+            // babel({
+            //     babelHelpers: "runtime",
+            //     configFile: './babel.config.js',
+            //     exclude: 'node_modules/**',
+            // }),
+            json(),
+            typescript({
+                tsconfigOverride: {
+                    compilerOptions: {
+                        declaration: false,
+                        declarationMap: false,
+                        module: "ESNext"
+                    }
+                }
+            })
+        ]
+    }
+]

package/CHANGELOG.md

@@ -2,4 +2,4 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [1.3.2](https://github.com/thinkkoa/koatty_cacheable/compare/v1.2.12...v1.3.2) (2021-11-20)
+### [1.3.7](https://github.com/thinkkoa/koatty_cacheable/compare/v1.3.6...v1.3.7) (2022-05-27)

package/dist/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Koatty
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/README.md

@@ -0,0 +1,57 @@
+# koatty_cacheable
+Cacheable for koatty.
+
+Koatty框架的 CacheAble, Cacheable, CacheEvict 支持库
+
+
+# Usage
+
+db.ts in koatty project:
+
+```js
+export default {
+    ...
+
+    "CacheStore": {
+        type: "memory", // redis or memory, memory is default
+        // key_prefix: "koatty",
+        // host: '127.0.0.1',
+        // port: 6379,
+        // name: "",
+        // username: "",
+        // password: "",
+        // db: 0,
+        // timeout: 30,
+        // pool_size: 10,
+        // conn_timeout: 30
+    },
+
+    ...
+};
+
+```
+
+used in service: 
+
+```js
+import { CacheAble, CacheEvict, GetCacheStore } from "koatty_cacheable";
+
+export class TestService {
+
+    @CacheAble("testCache") // auto cached
+    getTest(){
+        //todo
+    }
+
+    @CacheEvict("testCache") // auto clear cache
+    setTest(){
+        //todo
+    }
+
+    test(){
+        const store = GetCacheStore(this.app);
+        store.set(key, value);
+    }
+}
+
+```

package/dist/index.d.ts

@@ -1,35 +1,47 @@
-import { CacheStore } from "koatty_store";
-import { Application } from 'koatty_container';
-/**
- * get instances of cacheStore
- *
- * @export
- * @returns {*}
- */
-export declare function GetCacheStore(app: Application): Promise<CacheStore>;
-/**
- * Decorate this method to support caching. Redis server config from db.ts.
- * The cache method returns a value to ensure that the next time the method is executed with the same parameters,
- * the results can be obtained directly from the cache without the need to execute the method again.
- *
- * @export
- * @param {string} cacheName cache name
- * @param {(number | number[])} [paramKey] The index of the arguments.
- * @param {number} [timeout=3600] cache timeout
- * @returns {MethodDecorator}
- */
-export declare function CacheAble(cacheName: string, paramKey?: number | number[], timeout?: number): MethodDecorator;
-/**
- *
- */
-export declare type eventTimes = "Before" | "After";
-/**
- * Decorating the execution of this method will trigger a cache clear operation. Redis server config from db.ts.
- *
- * @export
- * @param {string} cacheName cacheName cache name
- * @param {(number | number[])} [paramKey] The index of the arguments.
- * @param {eventTimes} [eventTime="Before"]
- * @returns
- */
-export declare function CacheEvict(cacheName: string, paramKey?: number | number[], eventTime?: eventTimes): (target: any, methodName: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/*!
+* @Author: richen
+* @Date: 2022-05-27 11:35:52
+* @License: BSD (3-Clause)
+* @Copyright (c) - <richenlin(at)gmail.com>
+* @HomePage: https://koatty.org/
+*/
+import { Application } from 'koatty_container';
+import { CacheStore } from 'koatty_store';
+
+/**
+ * Decorate this method to support caching. Redis server config from db.ts.
+ * The cache method returns a value to ensure that the next time the method is executed with the same parameters,
+ * the results can be obtained directly from the cache without the need to execute the method again.
+ *
+ * @export
+ * @param {string} cacheName cache name
+ * @param {number} [timeout=3600] cache timeout
+ * @returns {MethodDecorator}
+ */
+export declare function CacheAble(cacheName: string, timeout?: number): MethodDecorator;
+
+/**
+ * Decorating the execution of this method will trigger a cache clear operation. Redis server config from db.ts.
+ *
+ * @export
+ * @param {string} cacheName cacheName cache name
+ * @param {eventTimes} [eventTime="Before"]
+ * @returns
+ */
+export declare function CacheEvict(cacheName: string, eventTime?: eventTimes): (target: any, methodName: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+
+/**
+ *
+ */
+export declare type eventTimes = "Before" | "After";
+
+/**
+ * get instances of cacheStore
+ *
+ * @export
+ * @param {Application} app
+ * @returns {*}  {CacheStore}
+ */
+export declare function GetCacheStore(app: Application): Promise<CacheStore>;
+
+export { }