Documentation

Documentation / zerotal / cache / CacheDriver

Interface: CacheDriver

Defined in: packages/cache/src/drivers/CacheDriver.ts:1

Methods

get()

get(key): Promise<string | null>

Defined in: packages/cache/src/drivers/CacheDriver.ts:6

Retrieve a cached value. Returns null if the key does not exist or has expired.

Parameters

key

string

Returns

Promise<string | null>

set()

set(key, value, ttl?): Promise<void>

Defined in: packages/cache/src/drivers/CacheDriver.ts:11

Store a value. ttl is in seconds; omit for no expiry.

Parameters

key

string

value

string

ttl?

number

Returns

Promise<void>

forget()

forget(key): Promise<void>

Defined in: packages/cache/src/drivers/CacheDriver.ts:16

Remove a single key.

Parameters

key

string

Returns

Promise<void>

has()

has(key): Promise<boolean>

Defined in: packages/cache/src/drivers/CacheDriver.ts:21

Check whether a key exists and has not expired.

Parameters

key

string

Returns

Promise<boolean>

flush()

flush(prefix?): Promise<void>

Defined in: packages/cache/src/drivers/CacheDriver.ts:27

Remove all keys matching the given prefix. Used by TaggedCache to flush a tag group.

Parameters

prefix?

string

Returns

Promise<void>

dispose()?

optional dispose(): void

Defined in: packages/cache/src/drivers/CacheDriver.ts:33

Release any background resources (timers, connections). Called on graceful shutdown by CacheManager.dispose().

Returns

void