Class Redis

Unit that loads configuration for and manages instantiation of an IORedis connection.

Hierarchy

Constructors

constructor

Properties

config connection? logging spawnedConnections status

Accessors

appClassApplication

Methods

app container down getBoundMethod getConnection getNewConnection make multi pipe up

Constructors

constructor

Properties

Protected Readonly config

config: Config

The config service.

Private Optional connection

connection?: Redis

The instantiated connection, if one exists.

Protected Readonly logging

logging: Logging

The loggers.

Private spawnedConnections

spawnedConnections: Collection<Redis> = ...

Collection of all Redis connections opened by this service. We keep track of these here so we can make sure -all- of them get closed when the framework tries to shut down.

status

status: UnitStatus = UnitStatus.Stopped

The current status of the unit.

Accessors

Private appClassApplication

Methods

Protected app

Protected container

down

  • This method is called to stop the unit when the application is shutting down. Here, you should do any teardown required to stop the package cleanly.

    IN PARTICULAR take care to free blocking resources that could prevent the process from exiting without a kill.

    Returns Promise<void>

getBoundMethod

  • Get the method with the given name from this class, bound to this class.

    Returns

    function

    Parameters

    • methodName: string

    Returns ((...args: any[]) => any)

      • (...args: any[]): any

      • Get the method with the given name from this class, bound to this class.

        Returns

        function

        Parameters

        • Rest ...args: any[]

        Returns any

getConnection

getNewConnection

Protected make

  • Call the make() method on the global container.

    Type Parameters

    • T

    Parameters

    • target: any
    • Rest ...parameters: any[]

    Returns T

multi

pipe

up

  • This method is called to start the unit when the application is booting. Here, you should do any setup required to get the package up and running.

    Returns Promise<void>

Settings

Member Visibility

Theme