eip-cloud-services 1.0.10 → 1.0.11

package/package.json

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

package/src/redis.js

@@ -49,6 +49,37 @@ exports.keys = async ( pattern ) => {
     }
 };
 
+/**
+ * Iteratively scans through keys in the Redis database.
+ * @param {number} cursor - The cursor to start scanning from. Use 0 to start a new scan.
+ * @param {string} [matchPattern='*'] - The pattern to match keys against. Defaults to '*' to match all keys.
+ * @param {number} [count=100] - The number of keys to return per call. Defaults to 100.
+ * @returns {Promise<Array>} - A promise that resolves with an array containing the next cursor and an array of keys.
+ *
+ * @description
+ * This method uses the SCAN command to iteratively scan through the keys in the Redis database.
+ * It allows for efficient scanning of large datasets without the risk of blocking the server for a long time.
+ * The method returns a promise that resolves with an array, where the first element is the next cursor to be used
+ * for subsequent calls, and the second element is an array of keys that matched the pattern.
+ */
+exports.scan = async ( cursor, matchPattern = '*', count = 100 ) => {
+    try {
+        const client = await getClient ();
+
+        const commandArgs = [
+            String ( cursor ),
+            'MATCH', matchPattern.startsWith ( config.redis.prefix ) ? matchPattern : config.redis.prefix + matchPattern,
+            'COUNT', String ( count ),
+        ];
+
+        return await client.sendCommand ( [ 'SCAN', ...commandArgs ] );
+    }
+    catch ( error ) {
+        console.log ( 'REDIS LIB ERROR [scan]', error );
+        throw error;
+    }
+};
+
 /**
  * Retrieves the value of a key.
  * @param {string} key - The key to retrieve.