basalt / cache-redis/src / RedisCacheDriver
Class: RedisCacheDriver
Defined in: cache-redis/src/index.ts:26
Cache driver contract. Every driver passes the same conformance suite.
Implements
Constructors
Constructor
> new RedisCacheDriver(redis): RedisCacheDriver
Defined in: cache-redis/src/index.ts:27
Parameters
redis
Redis
Returns
RedisCacheDriver
Methods
delete()
> delete(key): Promise<boolean>
Defined in: cache-redis/src/index.ts:60
Parameters
key
string
Returns
Promise<boolean>
Implementation of
disconnect()
> disconnect(): Promise<void>
Defined in: cache-redis/src/index.ts:90
Returns
Promise<void>
Implementation of
flushPrefix()
> flushPrefix(prefix): Promise<void>
Defined in: cache-redis/src/index.ts:68
Removes all keys starting with the prefix.
Parameters
prefix
string
Returns
Promise<void>
Implementation of
flushTags()
> flushTags(tags): Promise<void>
Defined in: cache-redis/src/index.ts:78
Removes all keys associated with any of the tags.
Parameters
tags
string[]
Returns
Promise<void>
Implementation of
get()
> get(key): Promise<unknown>
Defined in: cache-redis/src/index.ts:33
Returns the value, or undefined on miss/expired.
Parameters
key
string
Returns
Promise<unknown>
Implementation of
set()
> set(key, value, ttlMs?, tags?): Promise<void>
Defined in: cache-redis/src/index.ts:38
Parameters
key
string
value
unknown
ttlMs?
number
tags?
string[] = []
Returns
Promise<void>
Implementation of
fromUrl()
> static fromUrl(url): RedisCacheDriver
Defined in: cache-redis/src/index.ts:29
Parameters
url
string
Returns
RedisCacheDriver