ioredis 5.4.1 → 5.5.0

package/README.md

@@ -14,6 +14,8 @@ A robust, performance-focused and full-featured [Redis](http://redis.io) client
 
 Supports Redis >= 2.6.12. Completely compatible with Redis 7.x.
 
+ioredis is a stable project and maintenance is done on a best-effort basis for relevant issues (contributions to ioredis will still be evaluated, reviewed, and merged when they benefit the project). For new projects, node-redis is the recommended client library. [node-redis](https://github.com/redis/node-redis) is the open-source (MIT license) Redis JavaScript client library redesigned from the ground up and actively maintained. [node-redis](https://github.com/redis/node-redis) supports new (hash-field expiration) and future commands and the capabilities available in Redis Stack and Redis 8 (search, JSON, time-series, probabilistic data structures).
+
 # Features
 
 ioredis is a robust, full-featured Redis client that is
@@ -722,12 +724,18 @@ the key names are not utf8 strings.
 There are also `hscanStream`, `zscanStream` and `sscanStream` to iterate through elements in a hash, zset and set. The interface of each is
 similar to `scanStream` except the first argument is the key name:
 
+```javascript
+const stream = redis.zscanStream("myhash", {
+  match: "age:??",
+});
+```
+The `hscanStream` also accepts the `noValues` option to specify whether Redis should return only the keys in the hash table without their corresponding values.
 ```javascript
 const stream = redis.hscanStream("myhash", {
   match: "age:??",
+  noValues: true,
 });
 ```
-
 You can learn more from the [Redis documentation](http://redis.io/commands/scan).
 
 **Useful Tips**
@@ -1130,7 +1138,31 @@ const cluster = new Redis.Cluster(
 );
 ```
 
+Or you can specify this parameter through function:
+```javascript
+const cluster = new Redis.Cluster(
+  [
+    {
+      host: "203.0.113.73",
+      port: 30001,
+    },
+  ],
+  {
+    natMap: (key) => {
+      if(key.indexOf('30001')) {
+        return { host: "203.0.113.73", port: 30001 };
+      }
+
+      return null;
+    },
+  }
+);
+```
+
 This option is also useful when the cluster is running inside a Docker container.
+Also it works for Clusters in cloud infrastructure where cluster nodes connected through dedicated subnet.
+
+Specifying through may be useful if you don't know concrete internal host and know only node port.
 
 ### Transaction and Pipeline in Cluster Mode
 

package/built/DataHandler.js

@@ -21,9 +21,12 @@ class DataHandler {
                 this.returnReply(reply);
             },
         });
-        redis.stream.on("data", (data) => {
+        // prependListener ensures the parser receives and processes data before socket timeout checks are performed
+        redis.stream.prependListener("data", (data) => {
             parser.execute(data);
         });
+        // prependListener() doesn't enable flowing mode automatically - we need to resume the stream manually
+        redis.stream.resume();
     }
     returnFatalError(err) {
         err.message += ". Please report this.";

package/built/ScanStream.d.ts

@@ -7,6 +7,7 @@ interface Options extends ReadableOptions {
     command: string;
     redis: any;
     count?: string | number;
+    noValues?: boolean;
 }
 /**
  * Convenient class to convert the process of scanning keys to a readable stream.

package/built/ScanStream.js

@@ -29,6 +29,9 @@ class ScanStream extends stream_1.Readable {
         if (this.opt.count) {
             args.push("COUNT", String(this.opt.count));
         }
+        if (this.opt.noValues) {
+            args.push("NOVALUES");
+        }
         this.opt.redis[this.opt.command](args, (err, res) => {
             if (err) {
                 this.emit("error", err);

package/built/cluster/ClusterOptions.d.ts

@@ -5,12 +5,16 @@ import { CommanderOptions } from "../utils/Commander";
 import { NodeRole } from "./util";
 export declare type DNSResolveSrvFunction = (hostname: string, callback: (err: NodeJS.ErrnoException | null | undefined, records?: SrvRecord[]) => void) => void;
 export declare type DNSLookupFunction = (hostname: string, callback: (err: NodeJS.ErrnoException | null | undefined, address: string, family?: number) => void) => void;
-export interface NatMap {
+export declare type NatMapFunction = (key: string) => {
+    host: string;
+    port: number;
+} | null;
+export declare type NatMap = {
     [key: string]: {
         host: string;
         port: number;
     };
-}
+} | NatMapFunction;
 /**
  * Options for Cluster constructor
  */

package/built/cluster/index.js

@@ -628,15 +628,19 @@ class Cluster extends Commander_1.default {
         }
     }
     natMapper(nodeKey) {
-        if (this.options.natMap && typeof this.options.natMap === "object") {
-            const key = typeof nodeKey === "string"
-                ? nodeKey
-                : `${nodeKey.host}:${nodeKey.port}`;
-            const mapped = this.options.natMap[key];
-            if (mapped) {
-                debug("NAT mapping %s -> %O", key, mapped);
-                return Object.assign({}, mapped);
-            }
+        const key = typeof nodeKey === "string"
+            ? nodeKey
+            : `${nodeKey.host}:${nodeKey.port}`;
+        let mapped = null;
+        if (this.options.natMap && typeof this.options.natMap === "function") {
+            mapped = this.options.natMap(key);
+        }
+        else if (this.options.natMap && typeof this.options.natMap === "object") {
+            mapped = this.options.natMap[key];
+        }
+        if (mapped) {
+            debug("NAT mapping %s -> %O", key, mapped);
+            return Object.assign({}, mapped);
         }
         return typeof nodeKey === "string"
             ? (0, util_1.nodeKeyToRedisOptions)(nodeKey)

package/built/connectors/SentinelConnector/index.js

@@ -162,7 +162,15 @@ class SentinelConnector extends AbstractConnector_1.default {
     sentinelNatResolve(item) {
         if (!item || !this.options.natMap)
             return item;
-        return this.options.natMap[`${item.host}:${item.port}`] || item;
+        const key = `${item.host}:${item.port}`;
+        let result = item;
+        if (typeof this.options.natMap === "function") {
+            result = this.options.natMap(key) || item;
+        }
+        else if (typeof this.options.natMap === "object") {
+            result = this.options.natMap[key] || item;
+        }
+        return result;
     }
     connectToSentinel(endpoint, options) {
         const redis = new Redis_1.default({

package/built/types.d.ts

@@ -29,4 +29,5 @@ export interface ScanStreamOptions {
     match?: string;
     type?: string;
     count?: number;
+    noValues?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ioredis",
-  "version": "5.4.1",
+  "version": "5.5.0",
   "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
   "main": "./built/index.js",
   "types": "./built/index.d.ts",