basalt / cache/src / CacheDriver
Interface: CacheDriver
Defined in: cache/src/driver.ts:2
Cache driver contract. Every driver passes the same conformance suite.
Methods
delete()
> delete(key): Promise<boolean>
Defined in: cache/src/driver.ts:6
Parameters
key
string
Returns
Promise<boolean>
disconnect()
> disconnect(): Promise<void>
Defined in: cache/src/driver.ts:11
Returns
Promise<void>
flushPrefix()
> flushPrefix(prefix): Promise<void>
Defined in: cache/src/driver.ts:8
Removes all keys starting with the prefix.
Parameters
prefix
string
Returns
Promise<void>
flushTags()
> flushTags(tags): Promise<void>
Defined in: cache/src/driver.ts:10
Removes all keys associated with any of the tags.
Parameters
tags
string[]
Returns
Promise<void>
get()
> get(key): Promise<unknown>
Defined in: cache/src/driver.ts:4
Returns the value, or undefined on miss/expired.
Parameters
key
string
Returns
Promise<unknown>
set()
> set(key, value, ttlMs?, tags?): Promise<void>
Defined in: cache/src/driver.ts:5
Parameters
key
string
value
unknown
ttlMs?
number
tags?
string[]
Returns
Promise<void>