Add support for ioredis cluster 95 (#113)

danitseitlin · Jul 14, 2021 · c27cb76 · c27cb76
1 parent 3f0c102
commit c27cb76
Show file tree

Hide file tree

Showing 13 changed files with 209 additions and 53 deletions.
diff --git a/modules/redis-ai.ts b/modules/redis-ai.ts
@@ -4,14 +4,26 @@ import * as Redis from 'ioredis';
 export class RedisAI extends Module {
 
     /**
-     * Initializing the RedisAI object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
-     * @param moduleOptions.showDebugLogs If to print debug logs 
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(RedisAI.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(RedisAI.name, options, moduleOptions, clusterOptions) 
     }
 
     /**

diff --git a/modules/redis.ts b/modules/redis.ts
@@ -19,14 +19,26 @@ import { RedisTimeSeries } from './rts';
 export class Redis extends Module {
 
 	/**
-	 * Initializing the 'All In One' Redis object
-	 * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
+     */
+	constructor(clusterNodes: IORedis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: IORedis.ClusterOptions)
+	/**
+	 * Initializing the module object
+	 * @param name The name of the module
+	 * @param redisOptions The options of the redis database
 	 * @param moduleOptions The additional module options
 	 * @param moduleOptions.isHandleError If to throw error on error
 	 * @param moduleOptions.showDebugLogs If to print debug logs
 	 */
-	constructor(options: IORedis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-		super('Redis', options, moduleOptions)
+	constructor(redisOptions: IORedis.RedisOptions, moduleOptions?: RedisModuleOptions)
+	constructor(options: IORedis.RedisOptions & IORedis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: IORedis.ClusterOptions) {
+		super(Redis.name, options, moduleOptions, clusterOptions) 
 		this.applyMixins(Redis, [
 			RedisAI, RedisIntervalSets, RedisBloom, RedisBloomCMK, RedisBloomCuckoo, RedisBloomTopK, RedisBloomTDigest, Redisearch, RedisGears, RedisGraph, ReJSON, RedisTimeSeries
 		])

diff --git a/modules/redisbloom-cmk.ts b/modules/redisbloom-cmk.ts
@@ -4,14 +4,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class RedisBloomCMK extends Module {
 
     /**
-     * Initializing the RedisBloom Count-Min Sketch object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(RedisBloomCMK.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(RedisBloomCMK.name, options, moduleOptions, clusterOptions)
     }
 
     /**

diff --git a/modules/redisbloom-cuckoo.ts b/modules/redisbloom-cuckoo.ts
@@ -4,14 +4,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class RedisBloomCuckoo extends Module {
 
     /**
-     * Initializing the RedisCuckoo Cuckoo object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(RedisBloomCuckoo.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(RedisBloomCuckoo.name, options, moduleOptions, clusterOptions)
     }
 
     /**

diff --git a/modules/redisbloom-tdigest.ts b/modules/redisbloom-tdigest.ts
@@ -4,14 +4,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class RedisBloomTDigest extends Module {
 
     /**
-     * Initializing the RedisBloom TDigest object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(RedisBloomTDigest.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(RedisBloomTDigest.name, options, moduleOptions, clusterOptions)
     }
 
     /**

diff --git a/modules/redisbloom-topk.ts b/modules/redisbloom-topk.ts
@@ -4,14 +4,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class RedisBloomTopK extends Module {
 
     /**
-     * Initializing the RedisBloom Top-K object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(RedisBloomTopK.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(RedisBloomTopK.name, options, moduleOptions, clusterOptions)
     }
 
     /**

diff --git a/modules/redisbloom.ts b/modules/redisbloom.ts
@@ -4,14 +4,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class RedisBloom extends Module {
 
     /**
-     * Initializing the RedisBloom object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(RedisBloom.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(RedisBloom.name, options, moduleOptions, clusterOptions)
     }
 
     /**

diff --git a/modules/redisearch.ts b/modules/redisearch.ts
@@ -5,14 +5,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class Redisearch extends Module {
 
     /**
-     * Initializing the RediSearch object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(Redisearch.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(Redisearch.name, options, moduleOptions, clusterOptions)
     }
 
     /**

diff --git a/modules/redisgears.ts b/modules/redisgears.ts
@@ -4,14 +4,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class RedisGears extends Module {
 
     /**
-     * Initializing the RedisGears object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(RedisGears.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(RedisGears.name, options, moduleOptions, clusterOptions)
     }
 
     /**

diff --git a/modules/redisgraph.ts b/modules/redisgraph.ts
@@ -4,14 +4,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class RedisGraph extends Module {
 
     /**
-     * Initializing the RedisGraph object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(RedisGraph.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(RedisGraph.name, options, moduleOptions, clusterOptions)
     }
 
     /**

diff --git a/modules/rejson.ts b/modules/rejson.ts
@@ -5,14 +5,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class ReJSON extends Module {
 
     /**
-     * Initializing the ReJSON object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(ReJSON.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(ReJSON.name, options, moduleOptions, clusterOptions)
     }
 
     /**

diff --git a/modules/ris.ts b/modules/ris.ts
@@ -4,14 +4,26 @@ import { Module, RedisModuleOptions } from './module.base';
 export class RedisIntervalSets extends Module {
 
     /**
-     * Initializing the RedisIntervalSets object
-     * @param options The options of the Redis database.
+     * Initializing the module object
+     * @param name The name of the module
+     * @param clusterNodes The nodes of the cluster
      * @param moduleOptions The additional module options
      * @param moduleOptions.isHandleError If to throw error on error
      * @param moduleOptions.showDebugLogs If to print debug logs
+     * @param clusterOptions The options of the clusters
      */
-    constructor(options: Redis.RedisOptions, public moduleOptions?: RedisModuleOptions) {
-        super(RedisIntervalSets.name, options, moduleOptions)
+    constructor(clusterNodes: Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions)
+    /**
+     * Initializing the module object
+     * @param name The name of the module
+     * @param redisOptions The options of the redis database
+     * @param moduleOptions The additional module options
+     * @param moduleOptions.isHandleError If to throw error on error
+     * @param moduleOptions.showDebugLogs If to print debug logs
+     */
+    constructor(redisOptions: Redis.RedisOptions, moduleOptions?: RedisModuleOptions)
+    constructor(options: Redis.RedisOptions & Redis.ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: Redis.ClusterOptions) {
+        super(RedisIntervalSets.name, options, moduleOptions, clusterOptions)
     }
 
     /**