Whether or not to resend unfulfilled commands on reconnect.
Unfulfilled commands are most likely to be blocking commands such as
When the client reconnects, channels subscribed in the previous connection will be
resubscribed automatically if
If a command does not return a reply within a set number of milliseconds, a "Command timed out" error will be thrown.
How long the client will wait before killing a socket due to inactivity during initial connection.
Set the name of the connection to make it easier to identity the connection in client list.
Database index to use.
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.
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
Enable/disable keep-alive functionality.
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
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
This option is used to configure how many reconnection attempts should be allowed before
the queue is flushed with a
Set this options to
null instead of a number to let commands wait forever
until the connection is alive again.
This option is used internally when you call
redis.monitor() to tell Redis
to enter the monitor mode when the connection is established.
Enable/disable the use of Nagle's algorithm.
If set, client will send AUTH command with the value of this option when connected.
Whether or not to reconnect on certain Redis errors.
This options by default is
null, which means it should never reconnect on Redis errors.
You can pass a function that accepts an Redis error, and returns:
1to trigger a reconnection.
0to not reconnect.
2to reconnect and resend the failed command (who triggered the error) after reconnection.
This is necessary if you want to handle big numbers (above
Number.MAX_SAFE_INTEGER === 2^53).
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.
Generated using TypeDoc