Class Cache`Abstract`

Base class for Toshihiko cache implementations.

Hierarchy (View Summary)

EventEmitter
- Cache
  - RedisCache
  - MemcachedCache

Implements

Cache

Index

Constructors

Methods

deleteData deleteKeys getData setData

Constructors

constructor

new Cache(options?: EventEmitterOptions): Cache
Parameters
- Optionaloptions: EventEmitterOptions
Returns Cache
Inherited from EventEmitter.constructor
- Defined in common/temp/node_modules/@types/node/events.d.ts:101

Methods

`Abstract`deleteData

deleteData(
    database: string,
    table: string,
    key: CacheKey,
): Promise<CacheDeleteResult>
Deletes one cached row.
Parameters
- database: string
- table: string
- key: CacheKey
Returns Promise<CacheDeleteResult>
Implementation of Cache.deleteData
- Defined in packages/base-cache/src/index.ts:61

`Abstract`deleteKeys

deleteKeys(
    database: string,
    table: string,
    keys: readonly CacheKey[],
): Promise<CacheDeleteKeysResult>
Deletes cached rows for multiple keys.
Parameters
- database: string
- table: string
- keys: readonly CacheKey[]
Returns Promise<CacheDeleteKeysResult>
Implementation of Cache.deleteKeys
- Defined in packages/base-cache/src/index.ts:72

`Abstract`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)[]>
Implementation of Cache.getData
- Defined in packages/base-cache/src/index.ts:83

`Abstract`setData

setData<Value extends object>(
    database: string,
    table: string,
    key: CacheKey,
    data: Value,
): Promise<CacheSetResult>
Stores one serialized row under a Cache key.
Type Parameters
- Value extends object
Parameters
- database: string
- table: string
- key: CacheKey
- data: Value
Returns Promise<CacheSetResult>
Implementation of Cache.setData
- Defined in packages/base-cache/src/index.ts:94