docs/interfaces/CommonRedisOptions.html
Connector?: ConnectorConstructor
autoPipeliningIgnoredCommands?: string[]
default
[]
autoResendUnfulfilledCommands?: boolean
Whether or not to resend unfulfilled commands on reconnect. Unfulfilled commands are most likely to be blocking commands such as brpop or blpop.
default
true
autoResubscribe?: boolean
When the client reconnects, channels subscribed in the previous connection will be resubscribed automatically if autoResubscribe is true.
default
true
blockingTimeout?: number
Enables client-side timeout protection for blocking commands when set to a positive number. If blockingTimeout is undefined, 0, or negative (e.g. -1), the protection is disabled and no client-side timers are installed for blocking commands.
blockingTimeoutGrace?: number
Grace period (ms) added to blocking command timeouts. Only used when blockingTimeout is a positive number. Defaults to 100ms.
clientInfoTag?: string
Tag to append to the library name in CLIENT SETINFO (ioredis(tag)).
link
https://redis.io/docs/latest/commands/client-setinfo/
default
undefined
commandQueue?: boolean
commandTimeout?: number
If a command does not return a reply within a set number of milliseconds, a "Command timed out" error will be thrown.
connectTimeout?: number
How long the client will wait before killing a socket due to inactivity during initial connection.
default
10000
connectionName?: string
Set the name of the connection to make it easier to identity the connection in client list.
link
https://redis.io/commands/client-setname
db?: number
Database index to use.
default
0
disableClientInfo?: boolean
If true, skips setting library info via CLIENT SETINFO.
link
https://redis.io/docs/latest/commands/client-setinfo/
default
false
enableAutoPipelining?: boolean
default
false
enableOfflineQueue?: boolean
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
enableReadyCheck?: boolean
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
keepAlive?: number
Enable/disable keep-alive functionality.
link
https://nodejs.org/api/net.html#socketsetkeepaliveenable-initialdelay
default
0
keyPrefix?: string
lazyConnect?: boolean
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. When redis.connect() is called explicitly, a Promise is returned, which will be resolved when the connection is ready or rejected when it fails. The rejection should be handled by the user.
default
false
maxLoadingRetryTime?: number
default
10000
maxRetriesPerRequest?: number
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
monitor?: boolean
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
noDelay?: boolean
Enable/disable the use of Nagle's algorithm.
link
https://nodejs.org/api/net.html#socketsetnodelaynodelay
default
true
offlineQueue?: boolean
password?: string
If set, client will send AUTH command with the value of this option when connected.
readOnly?: boolean
default
false
reconnectOnError?: ReconnectOnError
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:
true or 1 to trigger a reconnection.false or 0 to not reconnect.2 to reconnect and resend the failed command (who triggered the error) after reconnection.example
const redis = new Redis({ reconnectOnError(err) { const targetError = "READONLY"; if (err.message.includes(targetError)) { // Only reconnect when the error contains "READONLY" return true; // or `return 1;` } },});
default
null
retryStrategy?: ((times: number) => number | void)
(times: number): number | void
-
scripts?: Record<string, { lua: string; numberOfKeys?: number; readOnly?: boolean }>
default
undefined
showFriendlyErrorStack?: boolean
socketTimeout?: number
If the socket does not receive data within a set number of milliseconds:
stringNumbers?: boolean
When enabled, numbers returned by Redis will be converted to JavaScript strings instead of numbers. This is necessary if you want to handle big numbers (above Number.MAX_SAFE_INTEGER === 2^53).
default
false
username?: 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.
Generated using TypeDoc