Class: Cache
Defined in: cache/src/index.ts:111
Constructors
Constructor
> new Cache(driver, options?, tenancyActive?): Cache
Defined in: cache/src/index.ts:119
Parameters
driver
options?
CacheOptions = {}
tenancyActive?
() => boolean
Whether the host app registered @basaltkit/tenancy. cachePlugin wires this to the container's 'tenancy:active' metadata marker — a signal, not an import. Defaults to false (single-tenant).
Returns
Cache
Methods
flush()
> flush(): Promise<void>
Defined in: cache/src/index.ts:170
Clears only the keys under this prefix/scope — never the entire Redis.
Returns
Promise<void>
forget()
> forget(key): Promise<boolean>
Defined in: cache/src/index.ts:165
Parameters
key
string
Returns
Promise<boolean>
get()
Call Signature
> get<T>(key): Promise<T | undefined>
Defined in: cache/src/index.ts:135
Type Parameters
T
T
Parameters
key
string
Returns
Promise<T | undefined>
Call Signature
> get<T>(key, fallback): Promise<T>
Defined in: cache/src/index.ts:136
Type Parameters
T
T
Parameters
key
string
fallback
T
Returns
Promise<T>
put()
> put(key, value, ttl?): Promise<void>
Defined in: cache/src/index.ts:143
Parameters
key
string
value
unknown
ttl?
Returns
Promise<void>
remember()
Call Signature
> remember<T>(key, ttl, factory): Promise<T>
Defined in: cache/src/index.ts:155
One-line cache-aside, with stampede protection: concurrent calls for the same key share ONE execution of the factory.
Type Parameters
T
T
Parameters
key
string
ttl
factory
() => T | Promise<T>
Returns
Promise<T>
Call Signature
> remember<T>(key, options, factory): Promise<T>
Defined in: cache/src/index.ts:156
One-line cache-aside, with stampede protection: concurrent calls for the same key share ONE execution of the factory.
Type Parameters
T
T
Parameters
key
string
options
factory
() => T | Promise<T>
Returns
Promise<T>
tags()
> tags(...tags): object
Defined in: cache/src/index.ts:184
Tag-scoped operations: cache.tags('plans').flush() invalidates the group.
Parameters
tags
...string[]
Returns
object
flush
> flush: () => Promise<void>
Returns
Promise<void>
put
> put: (key, value, ttl?) => Promise<void>
Parameters
key
string
value
unknown
ttl?
Returns
Promise<void>
remember
> remember: <T>(key, ttlOrOptions, factory) => Promise<T>
Type Parameters
T
T
Parameters
key
string
ttlOrOptions
factory
() => T | Promise<T>
Returns
Promise<T>