Options
All
  • Public
  • Public/Protected
  • All
Menu

RedisOptions objects encapsulate the logic of Redis client creation.

see

createOptions

Hierarchy

  • RedisOptions

Implemented by

Index

Methods

createClient

  • createClient(override?: undefined | object): IoRedis.Redis
  • Parameters

    • Optional override: undefined | object

      Options to be written over existing options before creating the client

    Returns IoRedis.Redis

    A Redis client configured according to the class type.

createUri

  • createUri(): string
  • Returns string

    A URI that lossily encodes a RedisOptions object.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc