クラス RedisCache

constructor

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

  Redis Cache を作成します。

  パラメータ

  • servers: string

    host:port 形式の Redis アドレスです。

  • オプションoptions: RedisCacheOptions

    ioredis のオプションと、任意の Cache キープレフィックスです。

  • オプションclient: Redis<"legacy">

    既存の ioredis クライアントです。主にインテグレーションとテストで使用します。

  戻り値 RedisCache

読み取り専用prefix

読み取り専用redis

deleteData

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

  キャッシュされた 1 行を削除します。

  パラメータ

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

  戻り値 Promise<number>

deleteKeys

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

  複数のキーに対応するキャッシュ済みデータ行を削除します。

  パラメータ

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

  戻り値 Promise<number[]>

getData

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

  要求時の順序でキャッシュ済みデータ行を読み取り、キャッシュミスには null を使用します。

  型パラメーター

  • Value extends object

  パラメータ

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

  戻り値 Promise<(Value | null)[]>

setData

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

  Cache キーの下にシリアライズ済みの 1 行を保存します。

  型パラメーター

  • Value extends object

  パラメータ

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

  戻り値 Promise<"OK" | null>