Class CacheManager

Index

Methods

clear clearPrefixEntries del enforceMaxSizeForPrefix get has keys keysForPrefix set size getInstance hashKey hashKeyFromObject

Methods

clear

clear(): Promise<boolean>
Clears all data from the cache.

Returns Promise<boolean>
Whether the cache was cleared
- Defined in src/classes/cache.ts:112

clearPrefixEntries

clearPrefixEntries(prefix): Promise<void>
Clears all entries that match the given prefix
Parameters
- prefix: string
  The prefix to use for filtering keys
Returns Promise<void>
- Defined in src/classes/cache.ts:168

del

del(key): Promise<boolean>
Deletes data from the cache, by it's key.
Parameters
- key: string
  The key to delete the data for
Returns Promise<boolean>
Whether the key existed in the cache
- Defined in src/classes/cache.ts:102

enforceMaxSizeForPrefix

enforceMaxSizeForPrefix(prefix, maxSize): Promise<void>
Enforces a maximum size for a set/category of keys by deleting the oldest keys if the size exceeds the maximum. The keys should be tracked by using prefixes (e.g. 'categoryName:categoryKey')
Parameters
- prefix: string
  The prefix to use for filtering keys
- maxSize: number
  The maximum size to enforce
Returns Promise<void>
Promise
- Defined in src/classes/cache.ts:156

get

get<T>(key): Promise<null | T>
Retrieves data from the cache, by it's key.
Type Parameters
- T
Parameters
- key: string
  The key to retrieve the data for
Returns Promise<null | T>
The data for the key, or null if it doesn't exist
- Defined in src/classes/cache.ts:76

has

has(key): Promise<boolean>
Checks if a key exists in the cache.
Parameters
- key: string
  The key to check for
Returns Promise<boolean>
Whether the key exists in the cache
- Defined in src/classes/cache.ts:130

keys

keys(): Promise<string[]>
Returns Promise<string[]>
All keys in the cache
- Defined in src/classes/cache.ts:121

keysForPrefix

keysForPrefix(prefix): Promise<string[]>
Sets/categories should be tracked by using prefixes (e.g. 'categoryName:categoryKey') This method returns all keys that match the given prefix.
Parameters
- prefix: string
Returns Promise<string[]>
- Defined in src/classes/cache.ts:145

set

set<T>(key, value, ttl): Promise<void>
Sets data in the cache, by it's key.
Type Parameters
- T
Parameters
- key: string
- value: T
- ttl: number
Returns Promise<void>
- Defined in src/classes/cache.ts:92

size

size(): Promise<number>
Returns Promise<number>
The number of keys in the cache
- Defined in src/classes/cache.ts:137

`Static`getInstance

getInstance(): CacheManager
Returns CacheManager
The singleton instance of the cache manager.
- Defined in src/classes/cache.ts:48

`Static`hashKey

hashKey(key): string
Hashes a key using SHA-256.
Parameters
- key: string
  The key to hash
Returns string
The hashed key
- Defined in src/classes/cache.ts:28

`Static`hashKeyFromObject

hashKeyFromObject(obj): string
Hashes an object using SHA-256, uses JSON.stringify to convert the object to a string.
Parameters
- obj: unknown
  The object to hash
Returns string
The hashed key for the object
- Defined in src/classes/cache.ts:37