Documentation / @zerotal/cache / index / RedisDriver
Class: RedisDriver
Defined in: cache/src/drivers/RedisDriver.ts:4
Implements
Constructors
Constructor
new RedisDriver(
prefix?):RedisDriver
Defined in: cache/src/drivers/RedisDriver.ts:7
Parameters
prefix?
string = ""
Returns
RedisDriver
Methods
get()
get(
key):Promise<string|null>
Defined in: cache/src/drivers/RedisDriver.ts:15
Retrieve a cached value. Returns null if the key does not exist or has expired.
Parameters
key
string
Returns
Promise<string | null>
Implementation of
set()
set(
key,value,ttl?):Promise<void>
Defined in: cache/src/drivers/RedisDriver.ts:19
Store a value. ttl is in seconds; omit for no expiry.
Parameters
key
string
value
string
ttl?
number
Returns
Promise<void>
Implementation of
forget()
forget(
key):Promise<void>
Defined in: cache/src/drivers/RedisDriver.ts:28
Remove a single key.
Parameters
key
string
Returns
Promise<void>
Implementation of
has()
has(
key):Promise<boolean>
Defined in: cache/src/drivers/RedisDriver.ts:32
Check whether a key exists and has not expired.
Parameters
key
string
Returns
Promise<boolean>
Implementation of
flush()
flush(
prefix?):Promise<void>
Defined in: cache/src/drivers/RedisDriver.ts:36
Remove all keys matching the given prefix. Used by TaggedCache to flush a tag group.
Parameters
prefix?
string
Returns
Promise<void>