@xnestjs/ioredis 1.5.2 → 1.6.0

package/README.md

@@ -108,6 +108,8 @@ export class MyModule {
 The library supports configuration through environment variables. Environment variables below is accepted.
 All environment variables starts with prefix (REDIS_). This can be configured while registering the module.
 
+<--- BEGIN env --->
+
 ### Standalone Connection Variables
 
 The following environment variables apply to the standalone connection.
@@ -140,3 +142,5 @@ The following environment variables apply to the standalone connection.
 | REDIS_KEEP_ALIVE              | Boolean |         | Enable/disable keep-alive functionality.                                                                                          |
 | REDIS_NO_DELAY                | Boolean |         | Enable/disable the use of Nagle's algorithm.                                                                                      |
 | REDIS_MAX_RETRIES_PER_REQUEST | Number  |         | Defines max retries per request value                                                                                             |
+
+<--- END env --->

package/cjs/get-redis-config.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRedisConfig = getRedisConfig;
+const tslib_1 = require("tslib");
+const node_process_1 = tslib_1.__importDefault(require("node:process"));
+const objects_1 = require("@jsopen/objects");
+const putil_varhelpers_1 = require("putil-varhelpers");
+const utils_js_1 = require("./utils.js");
+function getRedisConfig(options, prefix = 'REDIS_') {
+    const env = node_process_1.default.env;
+    const out = (0, objects_1.clone)(options || {});
+    let redisOptions;
+    if ((0, utils_js_1.isClusterOptions)(out)) {
+        redisOptions = out.redisOptions = out.redisOptions || {};
+        out.nodes = out.nodes ?? (env[prefix + 'NODES'] || 'localhost:6379').split(/\s*,\s*/);
+    }
+    else {
+        redisOptions = out;
+        out.host = out.host ?? env[prefix + 'HOST'] ?? 'localhost';
+        out.port = out.port ?? (0, putil_varhelpers_1.toIntDef)(env[prefix + 'PORT'], 6379);
+    }
+    redisOptions.db = redisOptions.db ?? (0, putil_varhelpers_1.toIntDef)(env[prefix + 'DB'], 0);
+    redisOptions.username = redisOptions.username ?? env[prefix + 'USERNAME'];
+    redisOptions.password = redisOptions.password ?? env[prefix + 'PASSWORD'];
+    redisOptions.autoResubscribe = redisOptions.autoResubscribe ?? (0, putil_varhelpers_1.toBoolean)(env[prefix + 'AUTO_RESUBSCRIBE']);
+    if (!redisOptions.reconnectOnError) {
+        let n = env[prefix + 'RECONNECT_ON_ERROR'];
+        if (n === 'true' || n === 'false') {
+            n = (0, putil_varhelpers_1.toBoolean)(n);
+        }
+        else
+            n = (0, putil_varhelpers_1.toInt)(n);
+        redisOptions.reconnectOnError = () => n;
+    }
+    redisOptions.connectTimeout = redisOptions.connectTimeout ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'CONNECT_TIMEOUT']);
+    redisOptions.socketTimeout = redisOptions.socketTimeout ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'SOCKET_TIMEOUT']);
+    redisOptions.keepAlive = redisOptions.keepAlive ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'KEEP_ALIVE']);
+    redisOptions.noDelay = redisOptions.noDelay ?? (0, putil_varhelpers_1.toBoolean)(env[prefix + 'NO_DELAY']);
+    redisOptions.connectionName = redisOptions.connectionName ?? env[prefix + 'CONNECTION_NAME'];
+    redisOptions.maxRetriesPerRequest =
+        redisOptions.maxRetriesPerRequest ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'MAX_RETRIES_PER_REQUEST']);
+    return out;
+}

package/cjs/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./get-redis-config.js"), exports);
 tslib_1.__exportStar(require("./redis.module.js"), exports);
 tslib_1.__exportStar(require("./redis-client.js"), exports);
 tslib_1.__exportStar(require("./shared-lock.js"), exports);

package/cjs/redis-core.module.js

@@ -4,20 +4,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisCoreModule = void 0;
 const tslib_1 = require("tslib");
 const node_assert_1 = tslib_1.__importDefault(require("node:assert"));
-const node_process_1 = tslib_1.__importDefault(require("node:process"));
-const objects_1 = require("@jsopen/objects");
 const common_1 = require("@nestjs/common");
 const ansi_colors_1 = tslib_1.__importDefault(require("ansi-colors"));
 const crypto = tslib_1.__importStar(require("crypto"));
 const ioredis_1 = tslib_1.__importStar(require("ioredis"));
-const putil_varhelpers_1 = require("putil-varhelpers");
 const constants_js_1 = require("./constants.js");
+const get_redis_config_js_1 = require("./get-redis-config.js");
 const redis_client_js_1 = require("./redis-client.js");
 const utils_js_1 = require("./utils.js");
 const CLIENT_TOKEN = Symbol('CLIENT_TOKEN');
 let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
     static forRoot(moduleOptions) {
-        const connectionOptions = this._readConnectionOptions(moduleOptions.useValue, moduleOptions.envPrefix);
+        const connectionOptions = (0, get_redis_config_js_1.getRedisConfig)(moduleOptions.useValue, moduleOptions.envPrefix);
         return this._createDynamicModule(moduleOptions, {
             global: moduleOptions.global,
             providers: [
@@ -38,7 +36,7 @@ let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
                     inject: asyncOptions.inject,
                     useFactory: async (...args) => {
                         const opts = await asyncOptions.useFactory(...args);
-                        return this._readConnectionOptions(opts, asyncOptions.envPrefix);
+                        return (0, get_redis_config_js_1.getRedisConfig)(opts, asyncOptions.envPrefix);
                     },
                 },
             ],
@@ -77,41 +75,6 @@ let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
             exports: [constants_js_1.IOREDIS_CONNECTION_OPTIONS, token, ...(metadata.exports ?? [])],
         };
     }
-    static _readConnectionOptions(options, prefix = 'REDIS_') {
-        const env = node_process_1.default.env;
-        const out = (0, objects_1.clone)(options || {});
-        let redisOptions;
-        if ((0, utils_js_1.isClusterOptions)(out)) {
-            redisOptions = out.redisOptions = out.redisOptions || {};
-            out.nodes = out.nodes ?? (env[prefix + 'NODES'] || 'localhost:6379').split(/\s*,\s*/);
-        }
-        else {
-            redisOptions = out;
-            out.host = out.host ?? env[prefix + 'HOST'] ?? 'localhost';
-            out.port = out.port ?? (0, putil_varhelpers_1.toIntDef)(env[prefix + 'PORT'], 6379);
-        }
-        redisOptions.db = redisOptions.db ?? (0, putil_varhelpers_1.toIntDef)(env[prefix + 'DB'], 0);
-        redisOptions.username = redisOptions.username ?? env[prefix + 'USERNAME'];
-        redisOptions.password = redisOptions.password ?? env[prefix + 'PASSWORD'];
-        redisOptions.autoResubscribe = redisOptions.autoResubscribe ?? (0, putil_varhelpers_1.toBoolean)(env[prefix + 'AUTO_RESUBSCRIBE']);
-        if (!redisOptions.reconnectOnError) {
-            let n = env[prefix + 'RECONNECT_ON_ERROR'];
-            if (n === 'true' || n === 'false') {
-                n = (0, putil_varhelpers_1.toBoolean)(n);
-            }
-            else
-                n = (0, putil_varhelpers_1.toInt)(n);
-            redisOptions.reconnectOnError = () => n;
-        }
-        redisOptions.connectTimeout = redisOptions.connectTimeout ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'CONNECT_TIMEOUT']);
-        redisOptions.socketTimeout = redisOptions.socketTimeout ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'SOCKET_TIMEOUT']);
-        redisOptions.keepAlive = redisOptions.keepAlive ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'KEEP_ALIVE']);
-        redisOptions.noDelay = redisOptions.noDelay ?? (0, putil_varhelpers_1.toBoolean)(env[prefix + 'NO_DELAY']);
-        redisOptions.connectionName = redisOptions.connectionName ?? env[prefix + 'CONNECTION_NAME'];
-        redisOptions.maxRetriesPerRequest =
-            redisOptions.maxRetriesPerRequest ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'MAX_RETRIES_PER_REQUEST']);
-        return out;
-    }
     static _createClient(options) {
         const opts = { ...options };
         let client;

package/esm/get-redis-config.js

@@ -0,0 +1,39 @@
+import process from 'node:process';
+import { clone } from '@jsopen/objects';
+import { toBoolean, toInt, toIntDef } from 'putil-varhelpers';
+import { isClusterOptions } from './utils.js';
+export function getRedisConfig(options, prefix = 'REDIS_') {
+    const env = process.env;
+    const out = clone(options || {});
+    let redisOptions;
+    if (isClusterOptions(out)) {
+        redisOptions = out.redisOptions = out.redisOptions || {};
+        out.nodes = out.nodes ?? (env[prefix + 'NODES'] || 'localhost:6379').split(/\s*,\s*/);
+    }
+    else {
+        redisOptions = out;
+        out.host = out.host ?? env[prefix + 'HOST'] ?? 'localhost';
+        out.port = out.port ?? toIntDef(env[prefix + 'PORT'], 6379);
+    }
+    redisOptions.db = redisOptions.db ?? toIntDef(env[prefix + 'DB'], 0);
+    redisOptions.username = redisOptions.username ?? env[prefix + 'USERNAME'];
+    redisOptions.password = redisOptions.password ?? env[prefix + 'PASSWORD'];
+    redisOptions.autoResubscribe = redisOptions.autoResubscribe ?? toBoolean(env[prefix + 'AUTO_RESUBSCRIBE']);
+    if (!redisOptions.reconnectOnError) {
+        let n = env[prefix + 'RECONNECT_ON_ERROR'];
+        if (n === 'true' || n === 'false') {
+            n = toBoolean(n);
+        }
+        else
+            n = toInt(n);
+        redisOptions.reconnectOnError = () => n;
+    }
+    redisOptions.connectTimeout = redisOptions.connectTimeout ?? toInt(env[prefix + 'CONNECT_TIMEOUT']);
+    redisOptions.socketTimeout = redisOptions.socketTimeout ?? toInt(env[prefix + 'SOCKET_TIMEOUT']);
+    redisOptions.keepAlive = redisOptions.keepAlive ?? toInt(env[prefix + 'KEEP_ALIVE']);
+    redisOptions.noDelay = redisOptions.noDelay ?? toBoolean(env[prefix + 'NO_DELAY']);
+    redisOptions.connectionName = redisOptions.connectionName ?? env[prefix + 'CONNECTION_NAME'];
+    redisOptions.maxRetriesPerRequest =
+        redisOptions.maxRetriesPerRequest ?? toInt(env[prefix + 'MAX_RETRIES_PER_REQUEST']);
+    return out;
+}

package/esm/index.js

@@ -1,3 +1,4 @@
+export * from './get-redis-config.js';
 export * from './redis.module.js';
 export * from './redis-client.js';
 export * from './shared-lock.js';

package/esm/redis-core.module.js

@@ -1,20 +1,18 @@
 var RedisCoreModule_1;
 import { __decorate, __metadata, __param } from "tslib";
 import assert from 'node:assert';
-import process from 'node:process';
-import { clone } from '@jsopen/objects';
 import { Inject, Logger } from '@nestjs/common';
 import colors from 'ansi-colors';
 import * as crypto from 'crypto';
 import Redis, { Cluster } from 'ioredis';
-import { toBoolean, toInt, toIntDef } from 'putil-varhelpers';
 import { IOREDIS_CONNECTION_OPTIONS, IOREDIS_MODULE_TOKEN } from './constants.js';
+import { getRedisConfig } from './get-redis-config.js';
 import { RedisClient } from './redis-client.js';
 import { isClusterOptions, isStandaloneOptions } from './utils.js';
 const CLIENT_TOKEN = Symbol('CLIENT_TOKEN');
 let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
     static forRoot(moduleOptions) {
-        const connectionOptions = this._readConnectionOptions(moduleOptions.useValue, moduleOptions.envPrefix);
+        const connectionOptions = getRedisConfig(moduleOptions.useValue, moduleOptions.envPrefix);
         return this._createDynamicModule(moduleOptions, {
             global: moduleOptions.global,
             providers: [
@@ -35,7 +33,7 @@ let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
                     inject: asyncOptions.inject,
                     useFactory: async (...args) => {
                         const opts = await asyncOptions.useFactory(...args);
-                        return this._readConnectionOptions(opts, asyncOptions.envPrefix);
+                        return getRedisConfig(opts, asyncOptions.envPrefix);
                     },
                 },
             ],
@@ -74,41 +72,6 @@ let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
             exports: [IOREDIS_CONNECTION_OPTIONS, token, ...(metadata.exports ?? [])],
         };
     }
-    static _readConnectionOptions(options, prefix = 'REDIS_') {
-        const env = process.env;
-        const out = clone(options || {});
-        let redisOptions;
-        if (isClusterOptions(out)) {
-            redisOptions = out.redisOptions = out.redisOptions || {};
-            out.nodes = out.nodes ?? (env[prefix + 'NODES'] || 'localhost:6379').split(/\s*,\s*/);
-        }
-        else {
-            redisOptions = out;
-            out.host = out.host ?? env[prefix + 'HOST'] ?? 'localhost';
-            out.port = out.port ?? toIntDef(env[prefix + 'PORT'], 6379);
-        }
-        redisOptions.db = redisOptions.db ?? toIntDef(env[prefix + 'DB'], 0);
-        redisOptions.username = redisOptions.username ?? env[prefix + 'USERNAME'];
-        redisOptions.password = redisOptions.password ?? env[prefix + 'PASSWORD'];
-        redisOptions.autoResubscribe = redisOptions.autoResubscribe ?? toBoolean(env[prefix + 'AUTO_RESUBSCRIBE']);
-        if (!redisOptions.reconnectOnError) {
-            let n = env[prefix + 'RECONNECT_ON_ERROR'];
-            if (n === 'true' || n === 'false') {
-                n = toBoolean(n);
-            }
-            else
-                n = toInt(n);
-            redisOptions.reconnectOnError = () => n;
-        }
-        redisOptions.connectTimeout = redisOptions.connectTimeout ?? toInt(env[prefix + 'CONNECT_TIMEOUT']);
-        redisOptions.socketTimeout = redisOptions.socketTimeout ?? toInt(env[prefix + 'SOCKET_TIMEOUT']);
-        redisOptions.keepAlive = redisOptions.keepAlive ?? toInt(env[prefix + 'KEEP_ALIVE']);
-        redisOptions.noDelay = redisOptions.noDelay ?? toBoolean(env[prefix + 'NO_DELAY']);
-        redisOptions.connectionName = redisOptions.connectionName ?? env[prefix + 'CONNECTION_NAME'];
-        redisOptions.maxRetriesPerRequest =
-            redisOptions.maxRetriesPerRequest ?? toInt(env[prefix + 'MAX_RETRIES_PER_REQUEST']);
-        return out;
-    }
     static _createClient(options) {
         const opts = { ...options };
         let client;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xnestjs/ioredis",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "NestJS extension library for ioredis",
   "author": "Panates",
   "license": "MIT",
@@ -13,8 +13,8 @@
   "peerDependencies": {
     "@nestjs/common": "^10.0.0 || ^11.0.0",
     "@nestjs/core": "^10.0.0 || ^11.0.0",
-    "ioredis": "^5.0.0",
-    "redis-semaphore": "^5.0.0"
+    "ioredis": "^5.5.0",
+    "redis-semaphore": "^5.6.1"
   },
   "type": "module",
   "exports": {

package/types/get-redis-config.d.ts

@@ -0,0 +1,2 @@
+import type { RedisClusterConnectionOptions, RedisStandaloneConnectionOptions } from './types';
+export declare function getRedisConfig(options?: RedisStandaloneConnectionOptions | RedisClusterConnectionOptions, prefix?: string): RedisStandaloneConnectionOptions | RedisClusterConnectionOptions;

package/types/index.d.cts

@@ -1,3 +1,4 @@
+export * from './get-redis-config.js';
 export * from './redis.module.js';
 export * from './redis-client.js';
 export * from './shared-lock.js';

package/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from './get-redis-config.js';
 export * from './redis.module.js';
 export * from './redis-client.js';
 export * from './shared-lock.js';

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

@@ -8,7 +8,6 @@ export declare class RedisCoreModule implements OnApplicationBootstrap, OnApplic
     static forRoot(moduleOptions: RedisModuleOptions): DynamicModule;
     static forRootAsync(asyncOptions: RedisAsyncModuleOptions): DynamicModule;
     private static _createDynamicModule;
-    private static _readConnectionOptions;
     private static _createClient;
     /**
      *