Interface RedisClientOptions<M, F, S>

Type Parameters

Hierarchy

Properties

clientInfoTag? commandsQueueMaxLength? database? disableClientInfo? disableOfflineQueue? functions? isolationPoolOptions? legacyMode? modules? name? password? pingInterval? readonly? scripts? socket? url? username?

Properties

Optional clientInfoTag

clientInfoTag?: string

Tag to append to library name that is sent to the Redis server

Optional commandsQueueMaxLength

commandsQueueMaxLength?: number

Maximum length of the client's internal command queue

Optional database

database?: number

Redis database number (see SELECT command)

Optional disableClientInfo

disableClientInfo?: boolean

If set to true, disables sending client identifier (user-agent like message) to the redis server

Optional disableOfflineQueue

disableOfflineQueue?: boolean

When true, commands are rejected when the client is reconnecting. When false, commands are queued for execution after reconnection.

Optional functions

functions?: F

Optional isolationPoolOptions

isolationPoolOptions?: Options

Optional legacyMode

legacyMode?: boolean

Optional modules

modules?: M

Optional name

name?: string

Client name (see CLIENT SETNAME)

Optional password

password?: string

ACL password or the old "--requirepass" password

Optional pingInterval

pingInterval?: number

Send PING command at interval (in ms). Useful with Redis deployments that do not use TCP Keep-Alive.

Optional readonly

readonly?: boolean

Connect in READONLY mode

Optional scripts

scripts?: S

Optional socket

socket?: RedisSocketOptions

Socket connection properties

Optional url

url?: string

redis[s]://[[username][:password]@][host][:port][/db-number] See redis and rediss IANA registration for more details

Optional username

username?: string

ACL username (see ACL guide)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc