@xnestjs/ioredis 0.0.1 → 0.2.0

package/{esm → cjs}/index.d.ts

@@ -1,5 +1,3 @@
-export * from './redis.decorators.js';
 export * from './redis.interface.js';
 export * from './redis.module.js';
-export * from './redis.utils.js';
 export * from './redis-client.js';

package/cjs/index.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./redis.decorators.js"), exports);
 tslib_1.__exportStar(require("./redis.interface.js"), exports);
 tslib_1.__exportStar(require("./redis.module.js"), exports);
-tslib_1.__exportStar(require("./redis.utils.js"), exports);
 tslib_1.__exportStar(require("./redis-client.js"), exports);
+//# sourceMappingURL=index.js.map

package/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/ioredis/src/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,4DAAkC;AAClC,4DAAkC"}

package/cjs/redis-client.d.ts

@@ -0,0 +1,10 @@
+import Redis, { Cluster } from 'ioredis';
+import { RedisLock } from './redis-lock.js';
+export interface RedisClient extends Redis, RedisLock {
+}
+export interface RedisCluster extends Cluster, RedisLock {
+}
+export declare class RedisClient extends Redis {
+}
+export declare class RedisCluster extends Cluster {
+}

package/cjs/redis-client.js

@@ -1,73 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisClient = void 0;
+exports.RedisCluster = exports.RedisClient = void 0;
 const tslib_1 = require("tslib");
-const ioredis_1 = tslib_1.__importDefault(require("ioredis"));
-const putil_varhelpers_1 = require("putil-varhelpers");
+const ioredis_1 = tslib_1.__importStar(require("ioredis"));
+const redis_lock_js_1 = require("./redis-lock.js");
 class RedisClient extends ioredis_1.default {
-    lockPrefix;
-    /**
-     * Try to lock once
-     * @param {string} name redis-lock name
-     * @param {number} [expire] milliseconds, TTL for the redis key
-     * @returns {boolean} true: success, false: failed
-     */
-    async tryLock(name, expire) {
-        const result = await this.set(this._getLockKey(name), '_lock_', 'PX', expire, 'NX');
-        return result !== null;
-    }
-    /**
-     * lock, automatically retrying if failed
-     * @param {string} name redis-lock name
-     * @param {object} [options] Options
-     * @param {number} [options.expire=60000] TTL
-     * @param {number} [options.retryInterval=100] milliseconds, the interval to retry if failed
-     * @param {number} [options.maxRetries=10] max times to retry
-     */
-    async lock(name, options) {
-        const expire = (0, putil_varhelpers_1.toNumberDef)(options?.expire, 60000);
-        const retryInterval = (0, putil_varhelpers_1.toNumberDef)(options?.retryInterval, 100);
-        const maxRetries = (0, putil_varhelpers_1.toNumberDef)(options?.maxRetries, 10);
-        let retryTimes = 0;
-        // eslint-disable-next-line no-constant-condition
-        while (1) {
-            if (await this.tryLock(name, expire)) {
-                break;
-            }
-            else {
-                await this._sleep(retryInterval);
-                if (retryTimes >= maxRetries) {
-                    throw new Error(`Redis lock "${name}" timed out`);
-                }
-                retryTimes++;
-            }
-        }
-    }
-    /**
-     * Unlock a redis-lock by name
-     * @param {string} name redis-lock name
-     */
-    async unlock(name) {
-        const s = 'if redis.call(\'get\', KEYS[1]) == ARGV[1] then return redis.call(\'del\', KEYS[1]) else return 0 end';
-        await this.eval(s, 1, this._getLockKey(name), '_lock_');
-    }
-    /**
-     * Set TTL for a redis-lock
-     * @param {string} name redis-lock name
-     * @param {number} milliseconds TTL
-     */
-    async setLockTTL(name, milliseconds) {
-        const result = await this.pexpire(this._getLockKey(name), milliseconds);
-        return !!result;
-    }
-    _getLockKey(name) {
-        return (this.lockPrefix || 'lock:') + name;
-    }
-    /**
-     * @param {number} ms milliseconds, the sleep interval
-     */
-    _sleep(ms) {
-        return new Promise(resolve => setTimeout(resolve, Number(ms)));
-    }
 }
 exports.RedisClient = RedisClient;
+class RedisCluster extends ioredis_1.Cluster {
+}
+exports.RedisCluster = RedisCluster;
+Object.assign(RedisClient.prototype, redis_lock_js_1.RedisLock.prototype);
+Object.assign(RedisCluster.prototype, redis_lock_js_1.RedisLock.prototype);
+//# sourceMappingURL=redis-client.js.map

package/cjs/redis-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-client.js","sourceRoot":"","sources":["../../../packages/ioredis/src/redis-client.ts"],"names":[],"mappings":";;;;AAAA,2DAAyC;AACzC,mDAA4C;AAQ5C,MAAa,WAAY,SAAQ,iBAAK;CACrC;AADD,kCACC;AAED,MAAa,YAAa,SAAQ,iBAAO;CACxC;AADD,oCACC;AAED,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,yBAAS,CAAC,SAAS,CAAC,CAAC;AAC1D,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,yBAAS,CAAC,SAAS,CAAC,CAAC"}

package/cjs/redis-core.module.d.ts

@@ -0,0 +1,15 @@
+import { DynamicModule, OnApplicationShutdown } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+import { RedisClientAsyncOptions, RedisClientOptions, RedisClusterAsyncOptions, RedisClusterOptions } from './redis.interface.js';
+export declare class RedisCoreModule implements OnApplicationShutdown {
+    private readonly options;
+    private readonly moduleRef;
+    constructor(options: RedisClientOptions | RedisClusterOptions, moduleRef: ModuleRef);
+    static registerClient(options?: RedisClientOptions): DynamicModule;
+    static registerClientAsync(asyncOptions: RedisClientAsyncOptions): DynamicModule;
+    static registerCluster(options: RedisClusterOptions): DynamicModule;
+    static registerClusterAsync(asyncOptions: RedisClusterAsyncOptions): DynamicModule;
+    private static _createClient;
+    private static _createCluster;
+    onApplicationShutdown(): Promise<void>;
+}

package/cjs/redis-core.module.js

@@ -7,23 +7,20 @@ const crypto = tslib_1.__importStar(require("crypto"));
 const common_1 = require("@nestjs/common");
 const core_1 = require("@nestjs/core");
 const redis_constants_js_1 = require("./redis.constants.js");
-const redis_utils_js_1 = require("./redis.utils.js");
 const redis_client_js_1 = require("./redis-client.js");
-let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
-    options;
-    moduleRef;
+let RedisCoreModule = exports.RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
     constructor(options, moduleRef) {
         this.options = options;
         this.moduleRef = moduleRef;
     }
-    static forRoot(options = {}) {
+    static registerClient(options = {}) {
         const optionsProvider = {
             provide: redis_constants_js_1.IOREDIS_MODULE_OPTIONS,
             useValue: options
         };
         const connectionProvider = {
-            provide: (0, redis_utils_js_1.getRedisClientToken)(options.name),
-            useFactory: () => this.createClient(options)
+            provide: options.token || redis_client_js_1.RedisClient,
+            useFactory: () => this._createClient(options)
         };
         return {
             module: RedisCoreModule_1,
@@ -31,88 +28,151 @@ let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
             exports: [connectionProvider]
         };
     }
-    static forRootAsync(asyncOptions) {
+    static registerClientAsync(asyncOptions) {
+        if (!asyncOptions.useFactory)
+            throw new Error('Invalid configuration. Must provide "useFactory"');
         const connectionProvider = {
-            provide: (0, redis_utils_js_1.getRedisClientToken)(asyncOptions.name),
+            provide: asyncOptions.token || redis_client_js_1.RedisClient,
             inject: [redis_constants_js_1.IOREDIS_MODULE_OPTIONS],
             useFactory: async (moduleOptions) => {
-                const name = asyncOptions.name || moduleOptions.name;
-                return this.createClient({
-                    ...moduleOptions,
-                    name
-                });
+                return this._createClient(moduleOptions);
             }
         };
-        const asyncProviders = this.createAsyncProviders(asyncOptions);
         return {
             module: RedisCoreModule_1,
             imports: asyncOptions.imports,
             providers: [
-                ...asyncProviders,
-                connectionProvider,
+                {
+                    provide: redis_constants_js_1.IOREDIS_MODULE_OPTIONS,
+                    useFactory: asyncOptions.useFactory,
+                    inject: asyncOptions.inject || []
+                },
                 {
                     provide: redis_constants_js_1.IOREDIS_MODULE_TOKEN,
                     useValue: crypto.randomUUID()
-                }
+                },
+                connectionProvider
             ],
             exports: [connectionProvider]
         };
     }
-    async onApplicationShutdown() {
-        const client = this.moduleRef.get((0, redis_utils_js_1.getRedisClientToken)(this.options.name));
-        if (client)
-            await client.quit();
+    static registerCluster(options) {
+        const optionsProvider = {
+            provide: redis_constants_js_1.IOREDIS_MODULE_OPTIONS,
+            useValue: options
+        };
+        const connectionProvider = {
+            provide: options.token || redis_client_js_1.RedisCluster,
+            useFactory: () => this._createCluster(options)
+        };
+        return {
+            module: RedisCoreModule_1,
+            providers: [connectionProvider, optionsProvider],
+            exports: [connectionProvider]
+        };
     }
-    static createAsyncProviders(asyncOptions) {
-        if (asyncOptions.useExisting || asyncOptions.useFactory)
-            return [this.createAsyncOptionsProvider(asyncOptions)];
-        if (asyncOptions.useClass)
-            return [
-                this.createAsyncOptionsProvider(asyncOptions),
+    static registerClusterAsync(asyncOptions) {
+        if (!asyncOptions.useFactory)
+            throw new Error('Invalid configuration. Must provide "useFactory"');
+        const connectionProvider = {
+            provide: asyncOptions.token || redis_client_js_1.RedisCluster,
+            inject: [redis_constants_js_1.IOREDIS_MODULE_OPTIONS],
+            useFactory: async (moduleOptions) => {
+                return this._createCluster(moduleOptions);
+            }
+        };
+        return {
+            module: RedisCoreModule_1,
+            imports: asyncOptions.imports,
+            providers: [
                 {
-                    provide: asyncOptions.useClass,
-                    useClass: asyncOptions.useClass
+                    provide: redis_constants_js_1.IOREDIS_MODULE_OPTIONS,
+                    useFactory: asyncOptions.useFactory,
+                    inject: asyncOptions.inject || []
+                },
+                connectionProvider,
+                {
+                    provide: redis_constants_js_1.IOREDIS_MODULE_TOKEN,
+                    useValue: crypto.randomUUID()
                 }
-            ];
-        throw new Error('Invalid configuration. Must provide useFactory, useClass or useExisting');
+            ],
+            exports: [connectionProvider]
+        };
     }
-    static createAsyncOptionsProvider(asyncOptions) {
-        if (asyncOptions.useFactory) {
-            return {
-                provide: redis_constants_js_1.IOREDIS_MODULE_OPTIONS,
-                useFactory: asyncOptions.useFactory,
-                inject: asyncOptions.inject || []
-            };
-        }
-        const useClass = asyncOptions.useClass || asyncOptions.useExisting;
-        if (useClass) {
-            return {
-                provide: redis_constants_js_1.IOREDIS_MODULE_OPTIONS,
-                useFactory: (optionsFactory) => optionsFactory.createOptions(asyncOptions.name),
-                inject: [useClass]
-            };
+    static async _createClient(options) {
+        if (options.host && options.host.includes('://')) {
+            const url = new URL(options.host);
+            options.host = url.hostname;
+            if (url.port)
+                options.port = parseInt(url.port, 10);
+            if (url.username)
+                options.username = url.username;
+            if (url.password)
+                options.password = url.password;
+            if (url.protocol === 'rediss:') { // @ts-ignore
+                options.tls = true;
+            }
+            const db = parseInt(url.pathname.substring(1), 10);
+            if (db > 0)
+                options.db = db;
         }
-        throw new Error('Invalid configuration. Must provide useFactory, useClass or useExisting');
-    }
-    static async createClient(options) {
         const client = new redis_client_js_1.RedisClient(options);
-        await new Promise((resolve, reject) => {
-            client.once('ready', () => {
-                client.removeListener('error', reject);
-                resolve();
-            });
-            client.once('error', (e) => {
-                client.removeListener('ready', resolve);
-                reject(e);
+        if (!options.lazyConnect) {
+            await new Promise((resolve, reject) => {
+                client.once('ready', () => {
+                    client.removeListener('error', reject);
+                    resolve();
+                });
+                client.once('error', (e) => {
+                    client.removeListener('ready', resolve);
+                    reject(e);
+                });
             });
-        });
+        }
         return client;
     }
+    static async _createCluster(options) {
+        const clusterOptions = {
+            ...options
+        };
+        delete clusterOptions.name;
+        delete clusterOptions.nodes;
+        const cluster = new redis_client_js_1.RedisCluster(options.nodes, clusterOptions);
+        if (!options.lazyConnect) {
+            await new Promise((resolve, reject) => {
+                cluster.once('ready', () => {
+                    cluster.removeListener('error', reject);
+                    resolve();
+                });
+                cluster.once('error', (e) => {
+                    cluster.removeListener('ready', resolve);
+                    reject(e);
+                });
+            });
+        }
+        return cluster;
+    }
+    async onApplicationShutdown() {
+        try {
+            const client = this.moduleRef.get(this.options.token || redis_client_js_1.RedisClient);
+            await client.quit();
+        }
+        catch {
+            //
+        }
+        try {
+            const cluster = this.moduleRef.get(this.options.token || redis_client_js_1.RedisCluster);
+            await cluster.quit();
+        }
+        catch {
+            //
+        }
+    }
 };
-RedisCoreModule = RedisCoreModule_1 = tslib_1.__decorate([
+exports.RedisCoreModule = RedisCoreModule = RedisCoreModule_1 = tslib_1.__decorate([
     (0, common_1.Global)(),
     (0, common_1.Module)({}),
     tslib_1.__param(0, (0, common_1.Inject)(redis_constants_js_1.IOREDIS_MODULE_OPTIONS)),
     tslib_1.__metadata("design:paramtypes", [Object, core_1.ModuleRef])
 ], RedisCoreModule);
-exports.RedisCoreModule = RedisCoreModule;
+//# sourceMappingURL=redis-core.module.js.map

package/cjs/redis-core.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-core.module.js","sourceRoot":"","sources":["../../../packages/ioredis/src/redis-core.module.ts"],"names":[],"mappings":";;;;;AAAA,uDAAiC;AAGjC,2CAGwB;AACxB,uCAAyC;AACzC,6DAG8B;AAK9B,uDAA8D;AAIvD,IAAM,eAAe,iDAArB,MAAM,eAAe;IAE1B,YAEqB,OAAiD,EACjD,SAAoB;QADpB,YAAO,GAAP,OAAO,CAA0C;QACjD,cAAS,GAAT,SAAS,CAAW;IAEzC,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,UAA8B,EAAE;QACpD,MAAM,eAAe,GAAG;YACtB,OAAO,EAAE,2CAAsB;YAC/B,QAAQ,EAAE,OAAO;SAClB,CAAC;QACF,MAAM,kBAAkB,GAAG;YACzB,OAAO,EAAE,OAAO,CAAC,KAAK,IAAI,6BAAW;YACrC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;SAC9C,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,iBAAe;YACvB,SAAS,EAAE,CAAC,kBAAkB,EAAE,eAAe,CAAC;YAChD,OAAO,EAAE,CAAC,kBAAkB,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,mBAAmB,CAAC,YAAqC;QAC9D,IAAI,CAAC,YAAY,CAAC,UAAU;YAC1B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEtE,MAAM,kBAAkB,GAAG;YACzB,OAAO,EAAE,YAAY,CAAC,KAAK,IAAI,6BAAW;YAC1C,MAAM,EAAE,CAAC,2CAAsB,CAAC;YAChC,UAAU,EAAE,KAAK,EAAE,aAAiC,EAAE,EAAE;gBACtD,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,iBAAe;YACvB,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,2CAAsB;oBAC/B,UAAU,EAAE,YAAY,CAAC,UAAU;oBACnC,MAAM,EAAE,YAAY,CAAC,MAAM,IAAI,EAAE;iBAClC;gBACD;oBACE,OAAO,EAAE,yCAAoB;oBAC7B,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE;iBAC9B;gBACD,kBAAkB;aACnB;YACD,OAAO,EAAE,CAAC,kBAAkB,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,OAA4B;QACjD,MAAM,eAAe,GAAG;YACtB,OAAO,EAAE,2CAAsB;YAC/B,QAAQ,EAAE,OAAO;SAClB,CAAC;QACF,MAAM,kBAAkB,GAAG;YACzB,OAAO,EAAE,OAAO,CAAC,KAAK,IAAI,8BAAY;YACtC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;SAC/C,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,iBAAe;YACvB,SAAS,EAAE,CAAC,kBAAkB,EAAE,eAAe,CAAC;YAChD,OAAO,EAAE,CAAC,kBAAkB,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,oBAAoB,CAAC,YAAsC;QAChE,IAAI,CAAC,YAAY,CAAC,UAAU;YAC1B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEtE,MAAM,kBAAkB,GAAG;YACzB,OAAO,EAAE,YAAY,CAAC,KAAK,IAAI,8BAAY;YAC3C,MAAM,EAAE,CAAC,2CAAsB,CAAC;YAChC,UAAU,EAAE,KAAK,EAAE,aAAkC,EAAE,EAAE;gBACvD,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;YAC5C,CAAC;SACF,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,iBAAe;YACvB,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,2CAAsB;oBAC/B,UAAU,EAAE,YAAY,CAAC,UAAU;oBACnC,MAAM,EAAE,YAAY,CAAC,MAAM,IAAI,EAAE;iBAClC;gBACD,kBAAkB;gBAClB;oBACE,OAAO,EAAE,yCAAoB;oBAC7B,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE;iBAC9B;aACF;YACD,OAAO,EAAE,CAAC,kBAAkB,CAAC;SAC9B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAA2B;QAC5D,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAChD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClC,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC;YAC5B,IAAI,GAAG,CAAC,IAAI;gBACV,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACxC,IAAI,GAAG,CAAC,QAAQ;gBACd,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;YAClC,IAAI,GAAG,CAAC,QAAQ;gBACd,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;YAClC,IAAI,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE,EAAE,aAAa;gBAC7C,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;aACpB;YACD,MAAM,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnD,IAAI,EAAE,GAAG,CAAC;gBACR,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;SACnB;QACD,MAAM,MAAM,GAAG,IAAI,6BAAW,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;YACxB,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC1C,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;oBACxB,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;oBACvC,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;oBACzB,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBACxC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACZ,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,OAA4B;QAC9D,MAAM,cAAc,GAAmB;YACrC,GAAG,OAAO;SACX,CAAC;QACF,OAAQ,cAAsB,CAAC,IAAI,CAAC;QACpC,OAAQ,cAAsB,CAAC,KAAK,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,8BAAY,CAAC,OAAO,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;YACxB,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC1C,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;oBACzB,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;oBACxC,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC,CAAC;gBACH,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;oBAC1B,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBACzC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACZ,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,qBAAqB;QACzB,IAAI;YACF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,6BAAW,CAAC,CAAC;YACrE,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;SACrB;QAAC,MAAM;YACN,EAAE;SACH;QACD,IAAI;YACF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,8BAAY,CAAC,CAAC;YACvE,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;SACtB;QAAC,MAAM;YACN,EAAE;SACH;IACH,CAAC;CAEF,CAAA;0BA/KY,eAAe;IAF3B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;IAIJ,mBAAA,IAAA,eAAM,EAAC,2CAAsB,CAAC,CAAA;qDAEH,gBAAS;GAL9B,eAAe,CA+K3B"}

package/{esm/redis-client.d.ts → cjs/redis-lock.d.ts}

@@ -1,10 +1,11 @@
-import Redis from 'ioredis';
+import Redis, { Cluster } from 'ioredis';
 export interface LockOptions {
     expire?: number;
     retryInterval?: number;
     maxRetries?: number;
 }
-export declare class RedisClient extends Redis {
+type This = RedisLock & (Redis | Cluster);
+export declare class RedisLock {
     lockPrefix?: string;
     /**
      * Try to lock once
@@ -12,7 +13,7 @@ export declare class RedisClient extends Redis {
      * @param {number} [expire] milliseconds, TTL for the redis key
      * @returns {boolean} true: success, false: failed
      */
-    tryLock(name: any, expire: any): Promise<boolean>;
+    tryLock(this: This, name: any, expire: any): Promise<boolean>;
     /**
      * lock, automatically retrying if failed
      * @param {string} name redis-lock name
@@ -21,21 +22,18 @@ export declare class RedisClient extends Redis {
      * @param {number} [options.retryInterval=100] milliseconds, the interval to retry if failed
      * @param {number} [options.maxRetries=10] max times to retry
      */
-    lock(name: string, options?: LockOptions): Promise<void>;
+    lock(this: This, name: string, options?: LockOptions): Promise<void>;
     /**
      * Unlock a redis-lock by name
      * @param {string} name redis-lock name
      */
-    unlock(name: any): Promise<void>;
+    unlock(this: This, name: any): Promise<void>;
     /**
      * Set TTL for a redis-lock
      * @param {string} name redis-lock name
      * @param {number} milliseconds TTL
      */
-    setLockTTL(name: any, milliseconds: any): Promise<boolean>;
+    setLockTTL(this: This, name: any, milliseconds: any): Promise<boolean>;
     private _getLockKey;
-    /**
-     * @param {number} ms milliseconds, the sleep interval
-     */
-    private _sleep;
 }
+export {};

package/cjs/redis-lock.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisLock = void 0;
+const putil_varhelpers_1 = require("putil-varhelpers");
+class RedisLock {
+    /**
+     * Try to lock once
+     * @param {string} name redis-lock name
+     * @param {number} [expire] milliseconds, TTL for the redis key
+     * @returns {boolean} true: success, false: failed
+     */
+    async tryLock(name, expire) {
+        const result = await this.set(this._getLockKey(name), '_lock_', 'PX', expire, 'NX');
+        return result !== null;
+    }
+    /**
+     * lock, automatically retrying if failed
+     * @param {string} name redis-lock name
+     * @param {object} [options] Options
+     * @param {number} [options.expire=60000] TTL
+     * @param {number} [options.retryInterval=100] milliseconds, the interval to retry if failed
+     * @param {number} [options.maxRetries=10] max times to retry
+     */
+    async lock(name, options) {
+        const expire = (0, putil_varhelpers_1.toNumberDef)(options?.expire, 60000);
+        const retryInterval = (0, putil_varhelpers_1.toNumberDef)(options?.retryInterval, 100);
+        const maxRetries = (0, putil_varhelpers_1.toNumberDef)(options?.maxRetries, 10);
+        let retryTimes = 0;
+        // eslint-disable-next-line no-constant-condition
+        while (1) {
+            if (await this.tryLock(name, expire)) {
+                break;
+            }
+            else {
+                await sleepAsync(retryInterval);
+                if (retryTimes >= maxRetries) {
+                    throw new Error(`Redis lock "${name}" timed out`);
+                }
+                retryTimes++;
+            }
+        }
+    }
+    /**
+     * Unlock a redis-lock by name
+     * @param {string} name redis-lock name
+     */
+    async unlock(name) {
+        const s = 'if redis.call(\'get\', KEYS[1]) == ARGV[1] then return redis.call(\'del\', KEYS[1]) else return 0 end';
+        await this.eval(s, 1, this._getLockKey(name), '_lock_');
+    }
+    /**
+     * Set TTL for a redis-lock
+     * @param {string} name redis-lock name
+     * @param {number} milliseconds TTL
+     */
+    async setLockTTL(name, milliseconds) {
+        const result = await this.pexpire(this._getLockKey(name), milliseconds);
+        return !!result;
+    }
+    _getLockKey(name) {
+        return (this.lockPrefix || 'lock:') + name;
+    }
+}
+exports.RedisLock = RedisLock;
+async function sleepAsync(ms) {
+    return new Promise(resolve => setTimeout(resolve, Number(ms)));
+}
+//# sourceMappingURL=redis-lock.js.map

package/cjs/redis-lock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-lock.js","sourceRoot":"","sources":["../../../packages/ioredis/src/redis-lock.ts"],"names":[],"mappings":";;;AACA,uDAA+C;AAU/C,MAAa,SAAS;IAIpB;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAa,IAAI,EAAE,MAAM;QAC3C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACpF,OAAO,MAAM,KAAK,IAAI,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,IAAI,CAAa,IAAY,EAAE,OAAqB;QAC/D,MAAM,MAAM,GAAG,IAAA,8BAAW,EAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QACnD,MAAM,aAAa,GAAG,IAAA,8BAAW,EAAC,OAAO,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC;QAC/D,MAAM,UAAU,GAAG,IAAA,8BAAW,EAAC,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;QAExD,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,iDAAiD;QACjD,OAAO,CAAC,EAAE;YACR,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE;gBACpC,MAAM;aACP;iBAAM;gBACL,MAAM,UAAU,CAAC,aAAa,CAAC,CAAC;gBAChC,IAAI,UAAU,IAAI,UAAU,EAAE;oBAC5B,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,aAAa,CAAC,CAAC;iBACnD;gBACD,UAAU,EAAE,CAAC;aACd;SACF;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAa,IAAI;QAClC,MAAM,CAAC,GAAG,uGAAuG,CAAC;QAClH,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAa,IAAI,EAAE,YAAY;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;QACxE,OAAO,CAAC,CAAC,MAAM,CAAC;IAClB,CAAC;IAEO,WAAW,CAAC,IAAI;QACtB,OAAO,CAAC,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,IAAI,CAAC;IAC7C,CAAC;CAEF;AAlED,8BAkEC;AAED,KAAK,UAAU,UAAU,CAAC,EAAU;IAClC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACjE,CAAC"}

package/cjs/redis.constants.js

@@ -3,3 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IOREDIS_MODULE_TOKEN = exports.IOREDIS_MODULE_OPTIONS = void 0;
 exports.IOREDIS_MODULE_OPTIONS = Symbol('IOREDIS_MODULE_OPTIONS');
 exports.IOREDIS_MODULE_TOKEN = Symbol('IOREDIS_MODULE_ID');
+//# sourceMappingURL=redis.constants.js.map

package/cjs/redis.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.constants.js","sourceRoot":"","sources":["../../../packages/ioredis/src/redis.constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAC;AAC1D,QAAA,oBAAoB,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC"}

package/cjs/redis.interface.d.ts

@@ -0,0 +1,33 @@
+import type { RedisOptions } from 'ioredis';
+import type { ClusterOptions } from 'ioredis/built/cluster/ClusterOptions';
+import type { ClusterNode } from 'ioredis/built/cluster/index.js';
+import type { ModuleMetadata } from '@nestjs/common/interfaces';
+export interface RedisClientOptions extends RedisOptions {
+    /**
+     * Injection token
+     */
+    token?: any;
+}
+export interface RedisClientAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    /**
+     * Injection token
+     */
+    token?: any;
+    useFactory?: (...args: any[]) => Promise<RedisClientOptions> | RedisClientOptions;
+    inject?: any[];
+}
+export interface RedisClusterOptions extends ClusterOptions {
+    /**
+     * Injection token
+     */
+    token?: any;
+    nodes: ClusterNode[];
+}
+export interface RedisClusterAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    /**
+     * Injection token
+     */
+    token?: any;
+    useFactory?: (...args: any[]) => Promise<RedisClusterOptions> | RedisClusterOptions;
+    inject?: any[];
+}

package/cjs/redis.interface.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=redis.interface.js.map

package/cjs/redis.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.interface.js","sourceRoot":"","sources":["../../../packages/ioredis/src/redis.interface.ts"],"names":[],"mappings":""}

package/cjs/redis.module.d.ts

@@ -0,0 +1,8 @@
+import { DynamicModule } from '@nestjs/common';
+import { RedisClientAsyncOptions, RedisClientOptions, RedisClusterAsyncOptions, RedisClusterOptions } from './redis.interface.js';
+export declare class RedisModule {
+    static registerClient(options: RedisClientOptions): DynamicModule;
+    static registerClientAsync(options: RedisClientAsyncOptions): DynamicModule;
+    static registerCluster(options: RedisClusterOptions): DynamicModule;
+    static registerClusterAsync(options: RedisClusterAsyncOptions): DynamicModule;
+}

package/cjs/redis.module.js

@@ -5,21 +5,33 @@ exports.RedisModule = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@nestjs/common");
 const redis_core_module_js_1 = require("./redis-core.module.js");
-let RedisModule = RedisModule_1 = class RedisModule {
-    static forRoot(options) {
+let RedisModule = exports.RedisModule = RedisModule_1 = class RedisModule {
+    static registerClient(options) {
         return {
             module: RedisModule_1,
-            imports: [redis_core_module_js_1.RedisCoreModule.forRoot(options)]
+            imports: [redis_core_module_js_1.RedisCoreModule.registerClient(options)]
         };
     }
-    static forRootAsync(options) {
+    static registerClientAsync(options) {
         return {
             module: RedisModule_1,
-            imports: [redis_core_module_js_1.RedisCoreModule.forRootAsync(options)]
+            imports: [redis_core_module_js_1.RedisCoreModule.registerClientAsync(options)]
+        };
+    }
+    static registerCluster(options) {
+        return {
+            module: RedisModule_1,
+            imports: [redis_core_module_js_1.RedisCoreModule.registerCluster(options)]
+        };
+    }
+    static registerClusterAsync(options) {
+        return {
+            module: RedisModule_1,
+            imports: [redis_core_module_js_1.RedisCoreModule.registerClusterAsync(options)]
         };
     }
 };
-RedisModule = RedisModule_1 = tslib_1.__decorate([
+exports.RedisModule = RedisModule = RedisModule_1 = tslib_1.__decorate([
     (0, common_1.Module)({})
 ], RedisModule);
-exports.RedisModule = RedisModule;
+//# sourceMappingURL=redis.module.js.map

package/cjs/redis.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.module.js","sourceRoot":"","sources":["../../../packages/ioredis/src/redis.module.ts"],"names":[],"mappings":";;;;;AAAA,2CAAuD;AAOvD,iEAAyD;AAGlD,IAAM,WAAW,yCAAjB,MAAM,WAAW;IACtB,MAAM,CAAC,cAAc,CAAC,OAA2B;QAC/C,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,OAAO,EAAE,CAAC,sCAAe,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,mBAAmB,CAAC,OAAgC;QACzD,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,OAAO,EAAE,CAAC,sCAAe,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;SACxD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,OAA4B;QACjD,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,OAAO,EAAE,CAAC,sCAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;SACpD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,oBAAoB,CAAC,OAAiC;QAC3D,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,OAAO,EAAE,CAAC,sCAAe,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;SACzD,CAAC;IACJ,CAAC;CACF,CAAA;sBA5BY,WAAW;IADvB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,WAAW,CA4BvB"}

package/esm/index.js

@@ -1,5 +1,4 @@
-export * from './redis.decorators.js';
 export * from './redis.interface.js';
 export * from './redis.module.js';
-export * from './redis.utils.js';
 export * from './redis-client.js';
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/ioredis/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}