Class Redis

constructor

• new Redis(options?): Redis

• Constructs a new instance of a redis-based cache

  Parameters

  • options: Partial<OptionsType> = {}

  Returns Redis

Readonly client

isReady

• get isReady(): Readonly<boolean>

• Returns if the instance is ready

  Returns Readonly<boolean>

Static type

• get type(): string

• Returns string

clear

• clear(): Promise<boolean>

• Deletes all keys (and values) from the cache

  Returns Promise<boolean>

connect

• connect(): Promise<void>

• Connects to the redis server

  Returns Promise<void>

del

• del<KeyType>(key): Promise<number>

• Deletes the key (including the value) from the cache

  Type Parameters

  • KeyType = any

  Parameters

  • key: KeyType

  Returns Promise<number>

disconnect

• disconnect(): Promise<void>

• Disconnects from the redis server

  Returns Promise<void>

get

• get<ValueType, KeyType>(key): Promise<undefined | ValueType>

• Retrieves the value of the specified key if it exists

  Type Parameters

  • ValueType = any
  • KeyType = any

  Parameters

  • key: KeyType

  Returns Promise<undefined | ValueType>

getTtl

• getTtl<KeyType>(key): Promise<undefined | number>

• Retrieves the current TTL of the specified key

  Type Parameters

  • KeyType = any

  Parameters

  • key: KeyType

  Returns Promise<undefined | number>

includes

• includes<KeyType>(key): Promise<boolean>

• Checks if the specified key exists in the cache

  Type Parameters

  • KeyType = any

  Parameters

  • key: KeyType

  Returns Promise<boolean>

keys

• keys<KeyType>(): Promise<KeyType[]>

• Retrieves a list of all keys

  Type Parameters

  • KeyType = any

  Returns Promise<KeyType[]>

list

• list<ValueType, KeyType>(): Promise<Map<KeyType, ValueType>>

• Retrieves a map of all the keys and values in the cache

  Type Parameters

  • ValueType = any
  • KeyType = any

  Returns Promise<Map<KeyType, ValueType>>

mdel

• mdel<KeyType>(keys): Promise<number>

• Mass deletes values with the specified keys

  Type Parameters

  • KeyType = any

  Parameters

  • keys: KeyType[]

  Returns Promise<number>

mget

• mget<ValueType, KeyType>(keys): Promise<Map<KeyType, ValueType>>

• Mass retrieves values with the specified keys

  Type Parameters

  • ValueType = any
  • KeyType = any

  Parameters

  • keys: KeyType[]

  Returns Promise<Map<KeyType, ValueType>>

mset

• mset<ValueType, KeyType>(keys, values, ttl?): Promise<boolean>

• Mass sets values with the specified keys

  Type Parameters

  • ValueType = any
  • KeyType = any

  Parameters

  • keys: KeyType[]
  • values: ValueType[]
  • ttl: number = ...

  Returns Promise<boolean>

on

• on(event, listener): this

• Parameters

  • event: "connect"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "ready"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "end"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "error"
  • listener: ((error) => void)
    • • (error): void

      • Parameters

        • error: Error

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "reconnecting"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this

set

• set<ValueType, KeyType>(key, value, ttl?): Promise<boolean>

• Sets the value for the specified key

  Type Parameters

  • ValueType = any
  • KeyType = any

  Parameters

  • key: KeyType
  • value: ValueType
  • ttl: number = ...

  Returns Promise<boolean>

take

• take<ValueType, KeyType>(key): Promise<undefined | ValueType>

• Retrieves the value of the specified key and immediately deletes it from the cache

  Type Parameters

  • ValueType = any
  • KeyType = any

  Parameters

  • key: KeyType

  Returns Promise<undefined | ValueType>

ttl

• ttl<KeyType>(key, ttl?): Promise<boolean>

• Updates the TTL for the specified key

  Type Parameters

  • KeyType = any

  Parameters

  • key: KeyType
  • ttl: number = ...

  Returns Promise<boolean>