fix: fix pr comments

Author: manast

lib/index.ts

@@ -4,7 +4,7 @@ import { Socket, Connection } from "./socket";
 export { Integration } from "./interfaces/integration";
 export { getRedisClient, FoundQueue, RedisConnection } from "./queue-factory";
 export { WebSocketClient } from "./ws-autoreconnect";
-export { Connection, ConnectionOptions, RedisConnection as RedisClient } from "./socket";
+export { Connection, ConnectionOptions } from "./socket";
 export { respond } from "./responders/respond";
 export { BullMQResponders } from "./responders/bullmq-responders";
 

lib/queue-factory.ts

@@ -166,13 +166,31 @@ export async function getRedisInfo(
   return info;
 }
 
+/**
+ * Gets or creates a Redis client for queue operations.
+ *
+ * @param redisOpts - Redis connection options. Required if existingClient is not provided.
+ * @param type - The type of queue ("bull" or "bullmq"), used for client caching key.
+ * @param clusterNodes - Optional list of cluster node URIs for Redis Cluster.
+ * @param existingClient - Optional pre-configured Redis/Cluster instance.
+ * @returns A Redis or Cluster client.
+ *
+ * @remarks
+ * When `existingClient` is provided, it is returned directly without caching.
+ * This allows the caller to manage the client lifecycle independently.
+ *
+ * When `redisOpts` are provided (without existingClient), the created client
+ * is cached internally using a checksum of the options. Subsequent calls with
+ * the same options will reuse the cached client.
+ */
 export function getRedisClient(
   redisOpts: RedisOptions | undefined,
   type: "bull" | "bullmq",
   clusterNodes?: string[],
   existingClient?: RedisConnection
 ) {
-  // If we have an existing client, use it directly
+  // If an existing client is provided, return it directly.
+  // We don't cache it since the caller owns its lifecycle.
   if (existingClient) {
     return existingClient;
   }
@@ -181,7 +199,7 @@ export function getRedisClient(
     throw new Error("Redis options are required when no client is provided");
   }
 
-  // Compute checksum for redisOpts
+  // Compute checksum for redisOpts to use as cache key
   const checksumJson = JSON.stringify(redisOpts);
   const checksum = require("crypto")
     .createHash("md5")

lib/queues-cache.ts

@@ -1,13 +1,16 @@
 import * as Bull from "bull";
 import { Queue } from "bullmq";
-import { Redis, Cluster, RedisOptions } from "ioredis";
+import { RedisOptions } from "ioredis";
 import { keyBy } from "lodash";
-import { FoundQueue, createQueue, getConnectionQueues } from "./queue-factory";
+import {
+  FoundQueue,
+  RedisConnection,
+  createQueue,
+  getConnectionQueues,
+} from "./queue-factory";
 import { Responders } from "./interfaces/responders";
 import { Integration } from "./interfaces/integration";
 
-export type RedisConnection = Redis | Cluster;
-
 let queuesCache: {
   [index: string]: { queue: Bull.Queue | Queue; responders: Responders };
 } = null;

lib/socket.ts

@@ -4,15 +4,14 @@ import { getCache, updateQueuesCache, queueKey } from "./queues-cache";
 import { WebSocketClient } from "./ws-autoreconnect";
 import {
   FoundQueue,
+  RedisConnection,
   execRedisCommand,
   getRedisInfo,
   ping,
 } from "./queue-factory";
 import { getQueueType, redisOptsFromUrl } from "./utils";
 import { Integration } from "./interfaces/integration";
 
-export type RedisConnection = Redis | Cluster;
-
 const { version } = require(`${__dirname}/../package.json`);
 
 const chalk = require("chalk");