CacheManager
Defined in: package/src/classes/CacheManager.ts:2
Class representing an in-memory cache manager
Type Parameters
Section titled “Type Parameters”T
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CacheManager<
T>():CacheManager<T>
Returns
Section titled “Returns”CacheManager<T>
Properties
Section titled “Properties”timestamps
Section titled “timestamps”timestamps:
Map<string,number>
Defined in: package/src/classes/CacheManager.ts:14
Timestamps for TTL tracking
optionalttl:number
Defined in: package/src/classes/CacheManager.ts:11
Time to live in milliseconds for cached items
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: package/src/classes/CacheManager.ts:93
Number of entries in the cache
Returns
Section titled “Returns”number
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<[string,T]>
Defined in: package/src/classes/CacheManager.ts:101
Returns
Section titled “Returns”IterableIterator<[string, T]>
clear()
Section titled “clear()”clear():
void
Defined in: package/src/classes/CacheManager.ts:87
Clear all entries from the cache
Returns
Section titled “Returns”void
delete()
Section titled “delete()”delete(
key):boolean
Defined in: package/src/classes/CacheManager.ts:81
Delete a value from the cache
Parameters
Section titled “Parameters”string
Key to delete
Returns
Section titled “Returns”boolean
True if key was deleted, false if it didn’t exist
get(
key):T|undefined
Defined in: package/src/classes/CacheManager.ts:29
Retrieve a value from the cache
Parameters
Section titled “Parameters”string
Key of value to retreive
Returns
Section titled “Returns”T | undefined
Cached value or undefined
has(
key):boolean
Defined in: package/src/classes/CacheManager.ts:63
Check if a key exists in the cache
Parameters
Section titled “Parameters”string
Key to check whether it exists
Returns
Section titled “Returns”boolean
Boolean representing whether the key exists and hasn’t expired
set(
key,value):CacheManager<T>
Defined in: package/src/classes/CacheManager.ts:48
Store a value in the cache
Parameters
Section titled “Parameters”string
Key to store value as
T
Value to store
Returns
Section titled “Returns”CacheManager<T>
CacheManager instance
setTTL()
Section titled “setTTL()”setTTL(
ttl):void
Defined in: package/src/classes/CacheManager.ts:20
Set the time to live for cache entries
Parameters
Section titled “Parameters”number
Time to live in milliseconds
Returns
Section titled “Returns”void
values()
Section titled “values()”values():
IterableIterator<T>
Defined in: package/src/classes/CacheManager.ts:97
Returns
Section titled “Returns”IterableIterator<T>