Interface RedisOptions

If true, client will resend unfulfilled commands(e.g. block commands) in the previous connection when reconnected. default: true.

After reconnected, if the previous connection was in the subscriber mode, client will auto re-subscribe these channels. default: true.

The milliseconds before a timeout occurs when executing a single command. By default, there is no timeout and the client will wait indefinitely. The timeout is enforced only on the client side, not server side. The server may still complete the operation after a timeout error occurs on the client side.

The milliseconds before a timeout occurs during the initial connection to the Redis server. default: 10000.

Database index to use.

If you are using the hiredis parser, it's highly recommended to enable this option. Create another instance with dropBufferSupport disabled for other commands that you want to return binary instead of string

When enabled, all commands issued during an event loop iteration are automatically wrapped in a pipeline and sent to the server at the same time. This can improve performance by 30-50%. default: false.

By default, if there is no active connection to the Redis server, 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.

When a connection is established to the Redis server, the server might still be loading the database from disk. While loading, the server not respond to any commands. To work around this, when this option is true, ioredis will check the status of the Redis server, and when the Redis server is able to process commands, a ready event will be emitted.

Whether to support the tls option when connecting to Redis via sentinel mode. default: false.

4 (IPv4) or 6 (IPv6), Defaults to 4.

TCP KeepAlive on the socket with a X ms delay before start. Set to a non-number value to disable keepAlive.

By default, all pending commands will be flushed with an error every 20 retry attempts. That makes sure commands won't wait forever when the connection is down. You can change this behavior by setting maxRetriesPerRequest.

Default script definition caching time.

default: null.

NAT map for sentinel connector. default: null.

Whether to disable the Nagle's Algorithm.

If set, client will send AUTH command with the value of this option when connected.

Local domain socket path. If set the port, host and family will be ignored.

Can be used to prefer a particular slave or set of slaves based on priority.

Enable READONLY mode for the connection. Only available for cluster mode. default: false.

default: "master".

Whether to show a friendly error stack. Will decrease the performance significantly.

Force numbers to be always returned as JavaScript strings. This option is necessary when dealing with big numbers (exceed the [-2^53, +2^53] range).

Update the given sentinels list with new IP addresses when communicating with existing sentinels. default: true.

If set, client will send AUTH command with the value of this option as the first argument when connected. The password option must be set too. Username should only be set for Redis >=6.