koatty_store 1.4.10 → 1.5.5

package/dist/redis.d.ts

@@ -1,321 +0,0 @@
-import IORedis from "ioredis";
-import { CacheStore, StoreOptions } from "./index";
-/**
- *
- *
- * @interface RedisStoreOptions
- */
-export interface RedisStoreOptions {
-    host?: string | Array<string>;
-    port?: number | Array<number>;
-    username?: string;
-    password?: string;
-    db: number;
-    keyPrefix: 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
- * @class RedisStore
- */
-export declare class RedisStore implements CacheStore {
-    private options;
-    private pool;
-    client: IORedis.Redis | IORedis.Cluster;
-    /**
-     * Creates an instance of RedisStore.
-     * @param {StoreOptions} options
-     * @memberof RedisStore
-     */
-    constructor(options: StoreOptions);
-    private parseOpt;
-    /**
-     * create connection by native
-     *
-     * @param {number} [connNum=0]
-     * @returns {*}  {Promise<IORedis.Redis | IORedis.Cluster>}
-     * @memberof RedisStore
-     */
-    private connect;
-    /**
-     * get connection from pool
-     *
-     * @returns {*}
-     * @memberof RedisStore
-     */
-    getConnection(): Promise<IORedis.Redis | IORedis.Cluster>;
-    /**
-     * 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>;
-    /**
-     * handler for native client
-     *
-     * @param {string} name
-     * @param {any[]} data
-     * @returns {*}
-     * @memberof RedisStore
-     */
-    private wrap;
-    /**
-     * 字符串获取
-     * @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>;
-    /**
-     * 批量删除，可模糊匹配
-     * @param keyword
-     * @returns {*}
-     */
-    batchrm(keyword: string): Promise<any>;
-    /**
-     * 判断key是否存在
-     * @param name
-     */
-    exists(name: string): Promise<any>;
-    /**
-     * 查找所有符合给定模式 pattern 的 key
-     * @param pattern
-     */
-    keys(pattern: 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>;
-    /**
-     * 返回哈希表 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
-     * @param key
-     * @returns {*}
-     */
-    hdel(name: string, key: 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 name
-     * @returns {*}
-     */
-    lpop(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>;
-}