Skip to content

Type Alias: RedisMutexConnection ​

RedisMutexConnection = object

The Redis connection of a RedisMutexDriver: a url, or a host and a port.

Properties ​

database? ​

optional database?: number

The index of the Redis database.

Default ​

ts
0

host? ​

optional host?: string

The host name or IP address of the server.

Default ​

ts
'127.0.0.1'

password? ​

optional password?: string

The password.

Default ​

ts
none

port? ​

optional port?: number

The port of the server.

Default ​

ts
6379

tls? ​

optional tls?: boolean

Whether to connect with TLS (ignored with a url: use rediss://).

Default ​

ts
false

url? ​

optional url?: string

The server URL (redis://user:password@host:6379/0, rediss:// for TLS). When set, host, port and tls are ignored; username, password and database apply when the URL does not give them.

Default ​

ts
none

username? ​

optional username?: string

The user name (Redis 6 ACL).

Default ​

ts
none (the default user)

Released under the MIT License.