Documentation / @zerotal/cache / index / MemoryDriver
Class: MemoryDriver
Defined in: cache/src/drivers/MemoryDriver.ts:10
Implements
Constructors
Constructor
new MemoryDriver(
sweepMs?):MemoryDriver
Defined in: cache/src/drivers/MemoryDriver.ts:19
Parameters
sweepMs?
number = ...
How often to run the background sweep (ms). Defaults to 5 minutes. Pass 0 to disable auto-sweeping.
Returns
MemoryDriver
Accessors
size
Get Signature
get size():
number
Defined in: cache/src/drivers/MemoryDriver.ts:81
Number of entries currently in the store (including expired-but-unswept).
Returns
number
Methods
get()
get(
key):Promise<string|null>
Defined in: cache/src/drivers/MemoryDriver.ts:25
Retrieve a cached value. Returns null if the key does not exist or has expired.
Parameters
key
string
Returns
Promise<string | null>
Implementation of
set()
set(
key,value,ttl?):Promise<void>
Defined in: cache/src/drivers/MemoryDriver.ts:35
Store a value. ttl is in seconds; omit for no expiry.
Parameters
key
string
value
string
ttl?
number
Returns
Promise<void>
Implementation of
forget()
forget(
key):Promise<void>
Defined in: cache/src/drivers/MemoryDriver.ts:40
Remove a single key.
Parameters
key
string
Returns
Promise<void>
Implementation of
has()
has(
key):Promise<boolean>
Defined in: cache/src/drivers/MemoryDriver.ts:44
Check whether a key exists and has not expired.
Parameters
key
string
Returns
Promise<boolean>
Implementation of
flush()
flush(
prefix?):Promise<void>
Defined in: cache/src/drivers/MemoryDriver.ts:54
Remove all keys matching the given prefix. Used by TaggedCache to flush a tag group.
Parameters
prefix?
string
Returns
Promise<void>
Implementation of
sweep()
sweep():
void
Defined in: cache/src/drivers/MemoryDriver.ts:70
Proactively remove all expired entries from the internal store.
Called automatically on the sweep interval. Also callable manually (e.g. before taking a memory snapshot or in tests).
Returns
void
dispose()
dispose():
void
Defined in: cache/src/drivers/MemoryDriver.ts:86
Stop the background sweep interval. Call during graceful shutdown.
Returns
void