ambiten / core/src / AmbitenCache
Class: AmbitenCache
Defined in: packages/core/src/ambiten-cache/ambitenCache.ts:28
Constructors
Constructor
new AmbitenCache(
client?):AmbitenCache
Defined in: packages/core/src/ambiten-cache/ambitenCache.ts:29
Parameters
client?
AmbitenCacheClient = redis
Returns
AmbitenCache
Methods
get()
get<
T>(key,options?):Promise<T|null>
Defined in: packages/core/src/ambiten-cache/ambitenCache.ts:59
Reads and deserializes a cached value.
Type Parameters
T
T
Parameters
key
string
options?
Returns
Promise<T | null>
invalidate()
invalidate(
key,options?):Promise<void>
Defined in: packages/core/src/ambiten-cache/ambitenCache.ts:120
Invalidates one cache key.
Parameters
key
string
options?
Returns
Promise<void>
invalidatePattern()
invalidatePattern(
pattern):Promise<number>
Defined in: packages/core/src/ambiten-cache/ambitenCache.ts:129
Invalidates cache keys by pattern using SCAN.
Parameters
pattern
string
Returns
Promise<number>
set()
set<
T>(key,value,options?):Promise<void>
Defined in: packages/core/src/ambiten-cache/ambitenCache.ts:81
Serializes and writes a cached value.
Type Parameters
T
T
Parameters
key
string
value
T
options?
AmbitenCacheOptions = {}
Returns
Promise<void>
wrap()
wrap<
T>(key,fetcher,options?):Promise<T>
Defined in: packages/core/src/ambiten-cache/ambitenCache.ts:100
Returns cached value if available, otherwise computes, stores, and returns it.
Type Parameters
T
T
Parameters
key
string
fetcher
() => Promise<T>
options?
AmbitenCacheOptions = {}
Returns
Promise<T>