Class RedisClient

Redis client which wraps node_redis client and handles:
- connection
- disconnection
- event listeners
- logging

Hierarchy

RedisClient

Constructors

constructor

Accessors

Methods

Constructors

constructor

new RedisClient(): RedisClient

Returns RedisClient

Accessors

client

get client(): NodeRedisClient

Get ConnectionType.REGULAR redis client.

Returns NodeRedisClient

connectionOptions

get connectionOptions(): Readonly<Record<ConnectionType, RedisConnectionOptions>>

Get connection options.

Returns Readonly<Record<ConnectionType, RedisConnectionOptions>>

db

get db(): string | number

Get index of the database where ConnectionType.REGULAR connection was established.

⚠ WARNING: Do not change database after ConnectionType.REGULAR connection was established.

Returns string | number

debug

get debug(): boolean
set debug(enable: boolean): void

Check whether redis is in debug_mode.

Returns boolean
Enable/Disable redis debug_mode.

Parameters
- enable: boolean
  
  Whether to enable.
Returns void

publisher

get publisher(): NodeRedisClient

Get ConnectionType.PUBLISHER redis client.

Returns NodeRedisClient

subscriber

get subscriber(): NodeRedisClient

Get ConnectionType.SUBSCRIBER redis client.

Returns NodeRedisClient

Methods

connect

connect(connections: Readonly<Partial<Record<ConnectionType, RedisConnectionOptions>>>, initializationOptions?: InitializationOptions): Promise<void>

Connect to Redis server.

Parameters
- connections: Readonly<Partial<Record<ConnectionType, RedisConnectionOptions>>>
  
  Which connections needs to be opened.
  At least ConnectionType.REGULAR connection needs to be specified.
- Optional initializationOptions: InitializationOptions
  
  Initialization options. These options are available for all established connections.
Returns Promise<void>

disconnect

disconnect(graceful?: boolean): Promise<void>

Disconnect from Redis server.
Closes all of the earlier established connections.

Parameters
- graceful: boolean = true
  
  Whether to perform graceful disconnect.
Returns Promise<void>

on

on(connectionType: ConnectionType, event: "message" | "message_buffer", listener: function): RedisClient
on(connectionType: ConnectionType, event: "pmessage" | "pmessage_buffer", listener: function): RedisClient
on(connectionType: ConnectionType, event: "subscribe" | "unsubscribe", listener: function): RedisClient
on(connectionType: ConnectionType, event: "psubscribe" | "punsubscribe", listener: function): RedisClient

Attach listener for event on connectionType.
This method is made because application modules tend to register listeners before connections are established. Connection is made from the client constructor, meaning that on listeners registering clients are not created yet. Therefore, listeners are queued before connections are established, and then registered. In case connection is established already, they will be registered on it and skip the queueing phase.

Parameters
- connectionType: ConnectionType
  
  Connection on which listener needs to be registered.
- event: "message" | "message_buffer"
  
  Event name.
- listener: function
  
  Event listener.
  - - (channel: string, message: string): void
    - Parameters
      - channel: string
      - message: string
      Returns void
Returns RedisClient
Attach listener for event on connectionType.
This method is made because application modules tend to register listeners before connections are established. Connection is made from the client constructor, meaning that on listeners registering clients are not created yet. Therefore, listeners are queued before connections are established, and then registered. In case connection is established already, they will be registered on it and skip the queueing phase.

Parameters
- connectionType: ConnectionType
  
  Connection on which listener needs to be registered.
- event: "pmessage" | "pmessage_buffer"
  
  Event name.
- listener: function
  
  Event listener.
  - - (pattern: string, channel: string, message: string): void
    - Parameters
      - pattern: string
      - channel: string
      - message: string
      Returns void
Returns RedisClient
Attach listener for event on connectionType.
This method is made because application modules tend to register listeners before connections are established. Connection is made from the client constructor, meaning that on listeners registering clients are not created yet. Therefore, listeners are queued before connections are established, and then registered. In case connection is established already, they will be registered on it and skip the queueing phase.

Parameters
- connectionType: ConnectionType
  
  Connection on which listener needs to be registered.
- event: "subscribe" | "unsubscribe"
  
  Event name.
- listener: function
  
  Event listener.
  - - (channel: string, count: number): void
    - Parameters
      - channel: string
      - count: number
      Returns void
Returns RedisClient
Attach listener for event on connectionType.
This method is made because application modules tend to register listeners before connections are established. Connection is made from the client constructor, meaning that on listeners registering clients are not created yet. Therefore, listeners are queued before connections are established, and then registered. In case connection is established already, they will be registered on it and skip the queueing phase.

Parameters
- connectionType: ConnectionType
  
  Connection on which listener needs to be registered.
- event: "psubscribe" | "punsubscribe"
  
  Event name.
- listener: function
  
  Event listener.
  - - (pattern: string, count: number): void
    - Parameters
      - pattern: string
      - count: number
      Returns void
Returns RedisClient

Class RedisClient

Hierarchy

Constructors

Accessors

Methods

Constructors

constructor

Returns RedisClient

Accessors

client

Returns NodeRedisClient

connectionOptions

Returns Readonly<Record<ConnectionType, RedisConnectionOptions>>

db

Returns string | number

debug

Returns boolean

Parameters

enable: boolean

Returns void

publisher

Returns NodeRedisClient

subscriber

Returns NodeRedisClient

Methods

connect

Parameters

connections: Readonly<Partial<Record<ConnectionType, RedisConnectionOptions>>>

Optional initializationOptions: InitializationOptions

Returns Promise<void>

disconnect

Parameters

graceful: boolean = true

Returns Promise<void>

on

Parameters

connectionType: ConnectionType

event: "message" | "message_buffer"

listener: function

Parameters

channel: string

message: string

Returns void

Returns RedisClient

Parameters

connectionType: ConnectionType

event: "pmessage" | "pmessage_buffer"

listener: function

Parameters

pattern: string

channel: string

message: string

Returns void

Returns RedisClient

Parameters

connectionType: ConnectionType

event: "subscribe" | "unsubscribe"

listener: function

Parameters

channel: string

count: number

Returns void

Returns RedisClient

Parameters

connectionType: ConnectionType

event: "psubscribe" | "punsubscribe"

listener: function

Parameters

pattern: string

count: number

Returns void

Returns RedisClient