Class MemcachedCache

constructor

• new MemcachedCache(
      servers: Location,
      options?: MemcachedCacheOptions,
      client?: Memcached,
  ): MemcachedCache

  Creates a Memcached Cache.

  Parameters

  • servers: Location

    Location accepted by the memcached client.

  • Optionaloptions: MemcachedCacheOptions

    Client options and Cache-key customization.

  • Optionalclient: Memcached

    Existing client, mainly for integration and tests.

  Returns MemcachedCache

Readonlymemcached

Readonlyoptions

Readonlyprefix

Readonlyservers

deleteData

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

  Deletes one cached row.

  Parameters

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

  Returns Promise<boolean>

deleteKeys

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

  Deletes cached rows for multiple keys.

  Parameters

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

  Returns Promise<void>

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)[]>

setCustomizeKeyFunc

• setCustomizeKeyFunc(func: CustomizeKey): void

  Replaces the Cache-key generator and binds it to this instance.

  Parameters

  • func: CustomizeKey

  Returns void

setData

• setData<Value extends object>(
      database: string,
      table: string,
      key: CacheKey,
      data: Value,
  ): Promise<boolean>

  Stores one serialized row under a Cache key.

  Type Parameters

  • Value extends object

  Parameters

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

  Returns Promise<boolean>