Class CacheManager<T>

A simple cache manager.

Type Parameters

T
The type of the cached objects.

Index

Constructors

Methods

clearCache get has set setTTL

Constructors

constructor

new CacheManager<T>(namespace, ttl?): CacheManager<T>
Construct a new CacheManager instance.
Type Parameters
- T
Parameters
- namespace: string
  The namespace to use for this cache.
- Optionalttl: number
  The TTL (Time-To-Live) for objects in cache.
  Default
  7200000 // 2 hours
Returns CacheManager<T>
- Defined in src/classes/other/CacheManager.ts:32

Methods

clearCache

clearCache(): Promise<void>
Clears the CacheManager.store.

Returns Promise<void>
- Defined in src/classes/other/CacheManager.ts:104

get

get(key): Promise<undefined | T>
Gets the value of the given key from the cache.
Parameters
- key: string
  The key to get.
Returns Promise<undefined | T>
- Defined in src/classes/other/CacheManager.ts:68

has

has(key): Promise<boolean>
Checks if the cache has a value for the given key.
Parameters
- key: string
  The key to check.
Returns Promise<boolean>
- Defined in src/classes/other/CacheManager.ts:80

set

set(key, value): Promise<void>
Sets a key to a value in the cache.
Parameters
- key: string
  The key to set.
- value: T
  The value to set.
Returns Promise<void>
- Defined in src/classes/other/CacheManager.ts:52

setTTL

setTTL(ttlMS?): void
Sets the CacheManager.ttl.
Parameters
- OptionalttlMS: number
  If provided, sets the CacheManager.ttl to this value, otherwise uses the default value.
Returns void
- Defined in src/classes/other/CacheManager.ts:92