Class Driver

Abstract base class required for implementing a cache driver.

Hierarchy

Driver
- Memory
- Memcached
- Redis

Index

Methods

Methods

Abstract close

close(): Promise<boolean>

- Defined in driver.ts:61
Closes connection or ends cache timeouts depending on underlying driver.

Returns Promise<boolean>

Abstract delete

delete(keys: string | string[]): Promise<number>

- Defined in driver.ts:56
Delete a key.

Parameters
- keys: string | string[]
Returns Promise<number>

Abstract expire

expire(key: string, ttl: number): Promise<boolean>

- Defined in driver.ts:50
Sets the expiry duration (in seconds) for a given key.

Parameters
- key: string
- ttl: number
  
  time-to-live in seconds
Returns Promise<boolean>

Abstract get

get(key: string): Promise<any>

- Defined in driver.ts:25
Gets the cached value at key.

Parameters
- key: string
Returns Promise<any>

Abstract has

has(key: string): Promise<boolean>

- Defined in driver.ts:19
Gets whether the key exists in cache.

Parameters
- key: string
Returns Promise<boolean>

Abstract keys

keys(): Promise<string[]>

- Defined in driver.ts:13
Lists all keys.

Returns Promise<string[]>

Abstract set

set(key: string, value: any, ttl?: number): Promise<boolean>

- Defined in driver.ts:33
Sets a value to be cached at key.

Parameters
- key: string
- value: any
- Optional ttl: number
  
  time-to-live in seconds
Returns Promise<boolean>

Abstract ttl

ttl(key: string): Promise<number>

- Defined in driver.ts:43
Gets the time-to-live of the key in seconds.

Parameters
- key: string
Returns Promise<number>

Generated using TypeDoc