rediser

Example

import rediser from '@mimik/rediser';

• rediser
  • module.exports(set, config) ⇒ object ⏏
    • async
      • ~validate() ⇒ Promise
    • sync
      • ~initializeSync() ⇒ object | null

module.exports(set, config) ⇒ object ⏏

Creates a Redis connection manager.

Kind: Exported function
Returns: object - An object with initializeSync and validate methods.

| Param | Type | Description | | --- | --- | --- | | set | string | Whether redis is enabled ('on' or 'off'). | | config | object | The application configuration object. | | config.redisSettings | object | Redis-specific settings. |

module.exports~validate() ⇒ Promise

Database connection validation.

Kind: inner method of module.exports
Returns: Promise - Resolves with null on success.
Category: async
Throws:

• Error Will throw an error if the database connection is not connected and is not disconnected.

Will exit 1 if the connection request times out and the connection state is not connected.

Requires: module:@mimik/sumologic-winston-logger
Fulfil: Return null.

module.exports~initializeSync() ⇒ object | null

Database initialization.

Kind: inner method of module.exports
Returns: object | null - The database client, or null if cache is not enabled.
Category: sync
Requires: module:@mimik/sumologic-winston-logger