ioredis - npm Package Compare versions

Comparing version 5.0.3 to 5.0.4

built/cluster/ClusterOptions.d.ts

@@ -6,4 +6,4 @@ /// <reference types="node" />
 import { NodeRole } from "./util";
-export declare type DNSResolveSrvFunction = (hostname: string, callback: (err: NodeJS.ErrnoException | undefined, records?: SrvRecord[]) => void) => void;
-export declare type DNSLookupFunction = (hostname: string, callback: (err: NodeJS.ErrnoException | undefined, address: string, family?: number) => void) => void;
+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 {
@@ -10,0 +10,0 @@ [key: string]: {

built/index.d.ts

@@ -36,4 +36,5 @@ export { default } from "./Redis";
 export { ClusterNode } from "./cluster";
-export { ClusterOptions } from "./cluster/ClusterOptions";
+export { ClusterOptions, DNSLookupFunction, DNSResolveSrvFunction, NatMap, } from "./cluster/ClusterOptions";
 export { NodeRole } from "./cluster/util";
+export type { RedisKey, RedisValue, ChainableCommander, } from "./utils/RedisCommander";
 export declare const ReplyError: any;
@@ -40,0 +41,0 @@ /**

built/redis/RedisOptions.d.ts

@@ -9,2 +9,6 @@ import { CommanderOptions } from "../utils/Commander";
     retryStrategy?: (times: number) => number | void | null;
+    /**
+     * If a command does not return a reply within a set number of milliseconds,
+     * a "Command timed out" error will be thrown.
+     */
     commandTimeout?: number;
@@ -29,5 +33,14 @@ /**
     connectionName?: string;
+    /**
+     * If set, client will send AUTH command with the value of this option as the first argument when connected.
+     * This is supported since Redis 6.
+     */
     username?: string;
+    /**
+     * If set, client will send AUTH command with the value of this option when connected.
+     */
     password?: string;
     /**
+     * Database index to use.
+     *
      * @default 0
@@ -37,2 +50,4 @@ */
     /**
+     * When the client reconnects, channels subscribed in the previous connection will be
+     * resubscribed automatically if `autoResubscribe` is `true`.
      * @default true
@@ -80,2 +95,3 @@ */
     /**
+     * How long the client will wait before killing a socket due to inactivity during initial connection.
      * @default 10000
@@ -85,2 +101,5 @@ */
     /**
+     * This option is used internally when you call `redis.monitor()` to tell Redis
+     * to enter the monitor mode when the connection is established.
+     *
      * @default false
@@ -90,2 +109,9 @@ */
     /**
+     * The commands that don't get a reply due to the connection to the server is lost are
+     * put into a queue and will be resent on reconnect (if allowed by the `retryStrategy` option).
+     * This option is used to configure how many reconnection attempts should be allowed before
+     * the queue is flushed with a `MaxRetriesPerRequestError` error.
+     * Set this options to `null` instead of a number to let commands wait forever
+     * until the connection is alive again.
+     *
      * @default 20
@@ -109,2 +135,9 @@ */
     /**
+     *
+     * By default, if the connection to Redis server has not been established, commands are added to a queue
+     * and are executed once the connection is "ready" (when `enableReadyCheck` is true, "ready" means
+     * the Redis server has loaded the database from disk, otherwise means the connection to the Redis
+     * server has been established). If this option is false, when execute the command when the connection
+     * isn't ready, an error will be returned.
+     *
      * @default true
@@ -114,2 +147,6 @@ */
     /**
+     * The client will sent an INFO command to check whether the server is still loading data from the disk (
+     * which happens when the server is just launched) when the connection is established, and only wait until
+     * the loading process is finished before emitting the `ready` event.
+     *
      * @default true
@@ -119,2 +156,6 @@ */
     /**
+     * When a Redis instance is initialized, a connection to the server is immediately established. Set this to
+     * true will delay the connection to the server until the first command is sent or `redis.connect()` is called
+     * explicitly.
+     *
      * @default false
@@ -121,0 +162,0 @@ */

package.json

 {
   "name": "ioredis",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
@@ -5,0 +5,0 @@ "main": "./built/index.js",

README.md

@@ -40,3 +40,3 @@ [![ioredis](https://cdn.jsdelivr.net/gh/luin/ioredis@b5e8c74/logo.svg)](https://github.com/luin/ioredis)
 
-| NPM Version    | Branch | Node.js Version | Redis Version   |
+| Version        | Branch | Node.js Version | Redis Version   |
 | -------------- | ------ | --------------- | --------------- |
@@ -52,3 +52,3 @@ | 5.x.x (latest) | main   | >= 12           | 2.6.12 ~ latest |
 
-- [API Documentation](http://luin.github.io/ioredis/) ([Redis](http://luin.github.io/ioredis/classes/default.html), [Cluster](http://luin.github.io/ioredis/classes/Cluster.html))
+- [API Documentation](https://luin.github.io/ioredis/) ([Redis](https://luin.github.io/ioredis/classes/Redis.html), [Cluster](https://luin.github.io/ioredis/classes/Cluster.html))
 - [Changelog](CHANGELOG.md)
@@ -169,3 +169,3 @@ - [Migrating from node_redis](https://github.com/luin/ioredis/wiki/Migrating-from-node_redis)
 
-All Redis commands are supported. See [the documentation](http://luin.github.io/ioredis/classes/default.html) for details.
+All Redis commands are supported. See [the documentation](https://luin.github.io/ioredis/classes/Redis.html) for details.
 
@@ -202,3 +202,3 @@ ## Connect to Redis
 
-See [API Documentation](http://luin.github.io/ioredis/index.html#RedisOptions) for all available options.
+See [API Documentation](https://luin.github.io/ioredis/index.html#RedisOptions) for all available options.
 
@@ -205,0 +205,0 @@ ## Pub/Sub

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

674103

increased by0.38%

Lines of code

14818

increased by0.28%

No dependency changes