eip-cloud-services 1.1.7 → 1.1.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eip-cloud-services",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "Houses a collection of helpers for connecting with Cloud services.",
   "main": "index.js",
   "scripts": {
@@ -23,4 +23,4 @@
     "mysql": "^2.18.1",
     "redis": "^4.6.7"
   }
-}
+}

package/src/redis.js

@@ -714,6 +714,32 @@ exports.subscribe = async ( channel, messageHandler ) => {
     }
 };
 
+/**
+ * Unsubscribes from a channel.
+ * @param {string} channel - The channel to unsubscribe from.
+ * @returns {Promise<void>} - A promise that resolves when the unsubscribe is complete.
+ *
+ * @description This method unsubscribes from the specified channel in Redis for incoming messages. 
+ */
+exports.unsubscribe = async (channel) => {
+    try {
+        if (typeof channel === 'string') {
+            const client = await getClient(`${channel}_sub`);
+
+            client.removeAllListeners('message');
+
+            await client.unsubscribe(channel);
+
+            return;
+        } else {
+            throw new Error('redis.unsubscribe expects a string channel and a function as handler');
+        }
+    } catch (error) {
+        console.error('REDIS LIB ERROR [unsubscribe]', error);
+        throw error;
+    }
+};
+
 /**
  * Retrieves information and statistics about the Redis server.
  * @returns {Promise<string>} - A promise that resolves with server information.