koatty_store 1.4.10 → 1.5.5

package/dist/index.d.ts

@@ -1,57 +1,866 @@
-import { MemoryStore } from "./memory";
-import { RedisStore } from "./redis";
-export { RedisStore, RedisStoreOptions } from "./redis";
-export { MemoryStore, MemoryStoreOptions } from "./memory";
-/**
- *
- *
- * @export
- * @interface StoreOptions
- */
-export interface StoreOptions {
-    type: string;
-    key_prefix: string;
-    host: string | Array<string>;
-    port?: number | Array<number>;
-    name?: string;
-    username?: string;
-    password?: string;
-    db?: number;
-    timeout?: number;
-    pool_size?: number;
-    conn_timeout?: number;
-}
-/**
- * CacheStore interface
- *
- * @export
- * @interface CacheStore
- */
-export interface CacheStore {
-    client: any;
-    getConnection(): any;
-    close(): Promise<void>;
-    release(conn: any): Promise<void>;
-    get(name: string): Promise<any>;
-    set(name: string, value: string | number, timeout?: number): Promise<any>;
-    del(name: string): Promise<any>;
-    defineCommand(name: string, scripts: any): any;
-    getCompare(name: string, value: string | number): Promise<any>;
-}
-/**
- *
- *
- * @export
- * @class Store
- */
-export declare class Store {
-    private static instance;
-    /**
-     *
-     *
-     * @static
-     * @returns
-     * @memberof ValidateUtil
-     */
-    static getInstance(options: StoreOptions): MemoryStore | RedisStore;
-}
+/*!
+* @Author: richen
+* @Date: 2022-05-27 10:34:41
+* @License: BSD (3-Clause)
+* @Copyright (c) - <richenlin(at)gmail.com>
+* @HomePage: https://koatty.org/
+*/
+/// <reference types="node" />
+
+import { EventEmitter } from 'events';
+
+/**
+ *
+ *
+ * @export
+ * @class Store
+ */
+export declare class CacheStore {
+    client: any;
+    pool: any;
+    options: StoreOptions;
+    /**
+     * Creates an instance of CacheStore.
+     * @param {StoreOptions} options
+     * @memberof CacheStore
+     */
+    constructor(options: StoreOptions);
+    getConnection(): void;
+    close(): Promise<void>;
+    release(conn: any): Promise<void>;
+    defineCommand(name: string, scripts: any): void;
+    getCompare(name: string, value: string | number): Promise<any>;
+    /**
+     * handler for native client
+     *
+     * @param {string} name
+     * @param {any[]} data
+     * @returns {*}
+     * @memberof RedisStore
+     */
+    /**
+     * 字符串获取
+     * @param name
+     */
+    get(name: string): Promise<any>;
+    /**
+     * 字符串写入
+     * @param name
+     * @param value
+     * @param timeout
+     * @returns {Promise}
+     */
+    set(name: string, value: string | number, timeout?: number): Promise<any>;
+    /**
+     * 以秒为单位，返回给定 key 的剩余生存时间
+     * @param name
+     * @returns {*}
+     */
+    ttl(name: string): Promise<any>;
+    /**
+     * 设置key超时属性
+     * @param name
+     * @param timeout
+     */
+    expire(name: string, timeout?: number): Promise<any>;
+    /**
+     * 删除key
+     * @param name
+     */
+    rm(name: string): Promise<any>;
+    /**
+     *
+     *
+     * @param {*} name
+     * @returns
+     */
+    del(name: string): Promise<any>;
+    /**
+     * 判断key是否存在
+     * @param name
+     */
+    exists(name: string): Promise<any>;
+    /**
+     * 自增
+     * @param name
+     */
+    incr(name: string): Promise<any>;
+    /**
+     * 自减
+     * @param name
+     * @returns {*}
+     */
+    decr(name: string): Promise<any>;
+    /**
+     * 将 key 所储存的值增加增量
+     * @param name
+     * @param incr
+     * @returns {*}
+     */
+    incrby(name: string, incr?: number): Promise<any>;
+    /**
+     * 将 key 所储存的值减去减量
+     *
+     * @param {any} name
+     * @param {any} decr
+     */
+    decrby(name: string, decr?: number): Promise<any>;
+    /**
+     * 哈希写入
+     * @param name
+     * @param key
+     * @param value
+     * @param timeout
+     */
+    hset(name: string, key: string, value: string | number, timeout?: number): Promise<any[]>;
+    /**
+     * 哈希获取
+     * @param name
+     * @param key
+     * @returns {*}
+     */
+    hget(name: string, key: string): Promise<any>;
+    /**
+     * 查看哈希表 hashKey 中，给定域 key 是否存在
+     * @param name
+     * @param key
+     * @returns {*}
+     */
+    hexists(name: string, key: string): Promise<any>;
+    /**
+     * 哈希删除
+     * @param name
+     * @param key
+     * @returns {*}
+     */
+    hdel(name: string, key: string): Promise<any[]>;
+    /**
+     * 返回哈希表 key 中域的数量
+     * @param name
+     * @returns {*}
+     */
+    hlen(name: string): Promise<any>;
+    /**
+     * 给哈希表指定key，增加increment
+     * @param name
+     * @param key
+     * @param incr
+     * @returns {*}
+     */
+    hincrby(name: string, key: string, incr?: number): Promise<any>;
+    /**
+     * 返回哈希表所有key-value
+     * @param name
+     * @returns {*}
+     */
+    hgetall(name: string): Promise<any>;
+    /**
+     * 返回哈希表所有key
+     * @param name
+     * @returns {*}
+     */
+    hkeys(name: string): Promise<any>;
+    /**
+     * 返回哈希表所有value
+     * @param name
+     * @returns {*}
+     */
+    hvals(name: string): Promise<any>;
+    /**
+     * 判断列表长度，若不存在则表示为空
+     * @param name
+     * @returns {*}
+     */
+    llen(name: string): Promise<any>;
+    /**
+     * 将值插入列表表尾
+     * @param name
+     * @param value
+     * @returns {*}
+     */
+    rpush(name: string, value: string | number): Promise<any>;
+    /**
+     *
+     *
+     * @param {string} name
+     * @param {(string | number)} value
+     * @returns {*}
+     * @memberof RedisStore
+     */
+    lpush(name: string, value: string | number): Promise<any>;
+    /**
+     * 将列表表头取出，并去除
+     * @param name
+     * @returns {*}
+     */
+    lpop(name: string): Promise<any>;
+    /**
+     *
+     *
+     * @param {string} name
+     * @returns {*}
+     * @memberof RedisStore
+     */
+    rpop(name: string): Promise<any>;
+    /**
+     * 返回列表 key 中指定区间内的元素，区间以偏移量 start 和 stop 指定
+     * @param name
+     * @param start
+     * @param stop
+     * @returns {*}
+     */
+    lrange(name: string, start: number, stop: number): Promise<any>;
+    /**
+     * 集合新增
+     * @param name
+     * @param value
+     * @param timeout
+     * @returns {*}
+     */
+    sadd(name: string, value: string | number, timeout?: number): Promise<any[]>;
+    /**
+     * 返回集合的基数(集合中元素的数量)
+     * @param name
+     * @returns {*}
+     */
+    scard(name: string): Promise<any>;
+    /**
+     * 判断 member 元素是否集合的成员
+     * @param name
+     * @param key
+     * @returns {*}
+     */
+    sismember(name: string, key: string): Promise<any>;
+    /**
+     * 返回集合中的所有成员
+     * @param name
+     * @returns {*}
+     */
+    smembers(name: string): Promise<any>;
+    /**
+     * 移除并返回集合中的一个随机元素
+     * @param name
+     * @returns {*}
+     */
+    spop(name: string): Promise<any>;
+    /**
+     * 移除集合 key 中的一个 member 元素
+     * @param name
+     * @param key
+     * @returns {*}
+     */
+    srem(name: string, key: string): Promise<any>;
+    /**
+     * 将 member 元素从 source 集合移动到 destination 集合
+     * @param source
+     * @param destination
+     * @param member
+     * @returns {*}
+     */
+    smove(source: string, destination: string, member: string): Promise<any>;
+}
+
+declare class MemoryCache extends EventEmitter {
+    options: MemoryCacheOptions;
+    currentDBIndex: number;
+    connected: boolean;
+    lastSave: number;
+    multiMode: boolean;
+    /**
+     * Creates an instance of MemoryCache.
+     * @param {*} options
+     * @memberof MemoryCache
+     */
+    constructor(options: MemoryCacheOptions);
+    /**
+     *
+     *
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    createClient(): this;
+    /**
+     *
+     *
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    quit(): this;
+    /**
+     *
+     *
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    end(): this;
+    /**
+     *
+     *
+     * @param {string} message
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    echo(message: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} message
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    ping(message: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} password
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    auth(password: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {number} dbIndex
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    select(dbIndex: number, callback?: Function): any;
+    get(key: string, callback?: Function): any;
+    /**
+     * set(key, value, ttl, pttl, notexist, onlyexist, callback)
+     *
+     * @param {string} key
+     * @param {(string | number)} value
+     * @param {...any[]} params
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    set(key: string, value: string | number, ...params: any[]): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    ttl(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {number} seconds
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    expire(key: string, seconds: number, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {...any[]} keys
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    del(...keys: any[]): any;
+    /**
+     *
+     *
+     * @param {...any[]} keys
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    exists(...keys: any[]): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    incr(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {number} amount
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    incrby(key: string, amount: number, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    decr(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {number} amount
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    decrby(key: string, amount: number, callback?: Function): any;
+    hset(key: string, field: string, value: string | number, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {string} field
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    hget(key: string, field: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {string} field
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    hexists(key: string, field: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {...any[]} fields
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    hdel(key: string, ...fields: any[]): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    hlen(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {string} field
+     * @param {*} value
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    hincrby(key: string, field: string, value: any, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    hgetall(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    hkeys(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    hvals(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    llen(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {(string | number)} value
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    rpush(key: string, value: string | number, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {(string | number)} value
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    lpush(key: string, value: string | number, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    lpop(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    rpop(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {number} start
+     * @param {number} stop
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    lrange(key: string, start: number, stop: number, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {...any[]} members
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    sadd(key: string, ...members: string[]): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    scard(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {string} member
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    sismember(key: string, member: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    smembers(key: string, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {number} [count]
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    spop(key: string, count?: number, callback?: Function): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {...any[]} members
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    srem(key: string, ...members: any[]): any;
+    /**
+     *
+     *
+     * @param {string} sourcekey
+     * @param {string} destkey
+     * @param {string} member
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    smove(sourcekey: string, destkey: string, member: string, callback?: Function): any;
+    discard(callback?: Function, silent?: boolean): any;
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @returns {*}  {boolean}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {*} value
+     * @param {string} type
+     * @param {number} timeout
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @param {number} amount
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @param {string} type
+     * @param {boolean} [throwError]
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @param {(number | string)} value
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @param {string} field
+     * @param {number} [amount]
+     * @param {boolean} [useFloat]
+     * @param {Function} [callback]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @param {string} field
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {string} key
+     * @param {string} field
+     * @returns {*}  {boolean}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @param {string} key
+     * @param {string} field
+     * @param {*} value
+     * @memberof MemoryCache
+     */
+    _setField(key: string, field: string, value: any): void;
+    /**
+     *
+     *
+     * @private
+     * @param {Function} [callback]
+     * @param {(any)} [message]
+     * @param {*} [error]
+     * @param {boolean} [nolog]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+    /**
+     *
+     *
+     * @private
+     * @param {any[]} [params]
+     * @returns {*}
+     * @memberof MemoryCache
+     */
+}
+
+/**
+ *
+ *
+ * @interface MemoryCacheOptions
+ */
+declare interface MemoryCacheOptions {
+    database: number;
+}
+
+export declare class MemoryStore extends CacheStore {
+    client: any;
+    pool: any;
+    options: StoreOptions;
+    /**
+     * Creates an instance of MemoryStore.
+     * @param {StoreOptions} options
+     * @memberof MemoryStore
+     */
+    constructor(options: StoreOptions);
+    /**
+     * getConnection
+     *
+     * @returns {*}
+     * @memberof MemoryStore
+     */
+    getConnection(): MemoryCache;
+    /**
+     * close
+     *
+     * @returns {*}  {Promise<void>}
+     * @memberof MemoryStore
+     */
+    close(): Promise<void>;
+    /**
+     * release
+     *
+     * @param {*} conn
+     * @returns {*}  {Promise<void>}
+     * @memberof MemoryStore
+     */
+    release(conn: any): Promise<void>;
+    /**
+     * defineCommand
+     *
+     * @param {string} name
+     * @param {*} scripts
+     * @memberof MemoryStore
+     */
+    defineCommand(name: string, scripts: any): Promise<void>;
+    /**
+     * get and compare value
+     *
+     * @param {string} name
+     * @param {(string | number)} value
+     * @returns {*}  {Promise<any>}
+     * @memberof MemoryStore
+     */
+    getCompare(name: string, value: string | number): Promise<any>;
+}
+
+/**
+ *
+ *
+ * @export
+ * @class Store
+ */
+export declare class Store {
+    /**
+     *
+     *
+     * @static
+     * @returns
+     * @memberof ValidateUtil
+     */
+    static getInstance(options: StoreOptions): CacheStore;
+}
+
+/**
+ *
+ *
+ * @export
+ * @interface StoreOptions
+ */
+export declare interface StoreOptions {
+    type?: string;
+    keyPrefix?: string;
+    host?: string | Array<string>;
+    port?: number | Array<number>;
+    username?: string;
+    password?: string;
+    db?: number;
+    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 { }