koatty_store 1.5.8 → 1.6.0

package/.rollup.config.js

@@ -3,61 +3,61 @@
  * @Usage: 
  * @Author: richen
  * @Date: 2021-12-17 10:20:44
- * @LastEditTime: 2021-12-18 11:58:46
+ * @LastEditTime: 2023-02-18 23:21:06
  */
 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"
-                    }
-                }
-            })
-        ]
-    }
+  {
+    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,6 +2,8 @@
 
 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.6.0](https://github.com/koatty/koatty_store/compare/v1.5.8...v1.6.0) (2023-02-18)
+
 ### [1.5.8](https://github.com/koatty/koatty_store/compare/v1.5.6...v1.5.8) (2023-01-13)
 
 ### [1.5.6](https://github.com/koatty/koatty_store/compare/v1.5.5...v1.5.6) (2022-11-03)

package/dist/index.d.ts

@@ -1,13 +1,20 @@
 /*!
 * @Author: richen
-* @Date: 2023-01-13 12:11:54
+* @Date: 2023-02-19 01:08:28
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
 /// <reference types="node" />
 
+import { Cluster } from 'ioredis';
+import { ClusterOptions } from 'ioredis';
+import { default as default_2 } from 'ioredis/built/cluster';
+import { default as default_3 } from 'ioredis/built/Redis';
 import { EventEmitter } from 'events';
+import genericPool from 'generic-pool';
+import { Redis } from 'ioredis';
+import { RedisOptions } from 'ioredis';
 
 /**
  *
@@ -16,8 +23,7 @@ import { EventEmitter } from 'events';
  * @class Store
  */
 export declare class CacheStore {
-    client: any;
-    pool: any;
+    client: MemoryStore | RedisStore;
     options: StoreOptions;
     /**
      * Creates an instance of CacheStore.
@@ -25,10 +31,17 @@ export declare class CacheStore {
      * @memberof CacheStore
      */
     constructor(options: StoreOptions);
-    getConnection(): void;
+    /**
+     *
+     *
+     * @static
+     * @returns
+     */
+    static getInstance(options: StoreOptions): CacheStore;
+    getConnection(): MemoryCache | Promise<default_2 | default_3>;
     close(): Promise<void>;
     release(conn: any): Promise<void>;
-    defineCommand(name: string, scripts: any): void;
+    defineCommand(name: string, scripts: any): Promise<any>;
     getCompare(name: string, value: string | number): Promise<any>;
     /**
      * handler for native client
@@ -260,6 +273,14 @@ export declare class CacheStore {
     smove(source: string, destination: string, member: string): Promise<any>;
 }
 
+declare interface CacheStoreInterface {
+    getConnection(): void;
+    close(): Promise<void>;
+    release(conn: any): Promise<void>;
+    defineCommand(name: string, scripts: any): void;
+    getCompare(name: string, value: string | number): Promise<any>;
+}
+
 declare class MemoryCache extends EventEmitter {
     options: MemoryCacheOptions;
     currentDBIndex: number;
@@ -765,16 +786,16 @@ declare interface MemoryCacheOptions {
     database: number;
 }
 
-export declare class MemoryStore extends CacheStore {
+declare class MemoryStore implements CacheStoreInterface {
     client: any;
     pool: any;
-    options: StoreOptions;
+    options: MemoryStoreOpt;
     /**
      * Creates an instance of MemoryStore.
-     * @param {StoreOptions} options
+     * @param {MemoryStoreOpt} options
      * @memberof MemoryStore
      */
-    constructor(options: StoreOptions);
+    constructor(options: MemoryStoreOpt);
     /**
      * getConnection
      *
@@ -816,51 +837,95 @@ export declare class MemoryStore extends CacheStore {
     getCompare(name: string, value: string | number): Promise<any>;
 }
 
+declare interface MemoryStoreOpt {
+    type: string;
+    keyPrefix?: string;
+    db?: number;
+    timeout?: number;
+}
+
 /**
  *
  *
  * @export
- * @class Store
+ * @class RedisStore
  */
-export declare class Store {
+declare class RedisStore implements CacheStoreInterface {
+    options: RedisStoreOpt;
+    pool: genericPool.Pool<Redis | Cluster>;
+    client: Redis | Cluster;
+    /**
+     * Creates an instance of RedisStore.
+     * @param {RedisStoreOpt} options
+     * @memberof RedisStore
+     */
+    constructor(options: RedisStoreOpt);
     /**
+     * create connection by native
      *
+     * @param {number} [connNum=0]
+     * @returns {*}  {Promise<Redis | Cluster>}
+     * @memberof RedisStore
+     */
+    /**
+     * get connection from pool
      *
-     * @static
-     * @returns
-     * @memberof ValidateUtil
+     * @returns {*}
+     * @memberof RedisStore
      */
-    static getInstance(options: StoreOptions): CacheStore;
+    getConnection(): Promise<Cluster | Redis>;
+    /**
+     * close connection
+     *
+     * @returns {*}
+     * @memberof RedisStore
+     */
+    close(): Promise<void>;
+    /**
+     *
+     *
+     * @param {*} conn
+     * @returns {*}
+     * @memberof RedisStore
+     */
+    release(conn: any): Promise<void>;
+    /**
+     * defineCommand
+     *
+     * @param {string} name
+     * @param {{ numberOfKeys?: number; lua?: string; }} scripts
+     * @returns {*}
+     * @memberof RedisStore
+     */
+    defineCommand(name: string, scripts: {
+        numberOfKeys?: number;
+        lua?: string;
+    }): Promise<any>;
+    /**
+     * get and compare value
+     *
+     * @param {string} name
+     * @param {(string | number)} value
+     * @returns {*}  {Promise<any>}
+     * @memberof RedisStore
+     */
+    getCompare(name: string, value: string | number): Promise<any>;
 }
 
 /**
- *
- *
- * @export
- * @interface StoreOptions
+ * @description:
+ * @return {*}
  */
-export declare interface StoreOptions {
-    type?: string;
-    keyPrefix?: string;
-    host?: string | Array<string>;
-    port?: number | Array<number>;
-    username?: string;
-    password?: string;
-    db?: number;
+declare interface RedisStoreOpt extends RedisOptions, ClusterOptions {
+    type: string;
     timeout?: number;
     poolSize?: number;
-    connectTimeout?: number;
-    name?: string;
-    sentinelUsername?: string;
-    sentinelPassword?: string;
-    sentinels?: Array<{
-        host: string;
-        port: number;
-    }>;
     clusters?: Array<{
         host: string;
         port: number;
     }>;
 }
 
+export declare type StoreOptions = MemoryStoreOpt | RedisStoreOpt;
+
 export { }