Class RedisCache

constructor

• new RedisCache(
      servers: string,
      options?: RedisCacheOptions,
      client?: Redis<"legacy">,
  ): RedisCache

  Creates a Redis Cache.

  Parameters

  • servers: string

    Redis address in host:port form.

  • Optionaloptions: RedisCacheOptions

    ioredis options and optional Cache-key prefix.

  • Optionalclient: Redis<"legacy">

    Existing ioredis client, mainly for integration and tests.

  Returns RedisCache

Readonlyprefix

Readonlyredis

deleteData

• deleteData(database: string, table: string, key: CacheKey): Promise<number>

  Deletes one cached row.

  Parameters

  • database: string
  • table: string
  • key: CacheKey

  Returns Promise<number>

deleteKeys

• deleteKeys(
      database: string,
      table: string,
      keys: readonly CacheKey[],
  ): Promise<number[]>

  Deletes cached rows for multiple keys.

  Parameters

  • database: string
  • table: string
  • keys: readonly CacheKey[]

  Returns Promise<number[]>

getData

• getData<Value extends object>(
      database: string,
      table: string,
      keys: CacheKey | readonly CacheKey[],
  ): Promise<(Value | null)[]>

  Reads cached rows in request order, using null for a cache miss.

  Type Parameters

  • Value extends object

  Parameters

  • database: string
  • table: string
  • keys: CacheKey | readonly CacheKey[]

  Returns Promise<(Value | null)[]>

setData

• setData<Value extends object>(
      database: string,
      table: string,
      key: CacheKey,
      data: Value,
  ): Promise<"OK" | null>

  Stores one serialized row under a Cache key.

  Type Parameters

  • Value extends object

  Parameters

  • database: string
  • table: string
  • key: CacheKey
  • data: Value

  Returns Promise<"OK" | null>