Cache
Defined in: packages/collection/src/cache.ts:23
Bounded cache with a fixed TTL, least-recently-used eviction and explicit invalidation. A thin policy layer over Collection: reads promote an entry but do not extend its TTL.
Type Parameters
Section titled “Type Parameters”K
V
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Cache<
K,V>(options?):Cache<K,V>
Defined in: packages/collection/src/cache.ts:27
Creates a cache using the supplied retention policy.
Parameters
Section titled “Parameters”options?
Section titled “options?”CacheOptions = {}
Returns
Section titled “Returns”Cache<K, V>
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: packages/collection/src/cache.ts:52
Number of currently live entries.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”clear()
Section titled “clear()”clear():
void
Defined in: packages/collection/src/cache.ts:73
Invalidates every cached resource.
Returns
Section titled “Returns”void
delete()
Section titled “delete()”delete(
key):boolean
Defined in: packages/collection/src/cache.ts:69
Invalidates one key.
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”boolean
dispose()
Section titled “dispose()”dispose():
void
Defined in: packages/collection/src/cache.ts:85
Kept for compatibility: there is no background sweeper to stop.
Returns
Section titled “Returns”void
entries()
Section titled “entries()”entries(): [
K,V][]
Defined in: packages/collection/src/cache.ts:91
Returns live cached entries.
Returns
Section titled “Returns”[K, V][]
get(
key):V|undefined
Defined in: packages/collection/src/cache.ts:56
Reads a live entry and marks it most recently used.
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”V | undefined
has(
key):boolean
Defined in: packages/collection/src/cache.ts:60
Returns whether a live entry exists.
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”boolean
invalidate()
Section titled “invalidate()”invalidate(
predicate):number
Defined in: packages/collection/src/cache.ts:77
Invalidates every entry matching a predicate.
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, key) => boolean
Returns
Section titled “Returns”number
set(
key,value):this
Defined in: packages/collection/src/cache.ts:64
Stores an entry and evicts the least recently used ones when the bound is exceeded.
Parameters
Section titled “Parameters”K
V
Returns
Section titled “Returns”this
sweep()
Section titled “sweep()”sweep():
number
Defined in: packages/collection/src/cache.ts:81
Removes expired entries now and returns the number removed.
Returns
Section titled “Returns”number
values()
Section titled “values()”values():
V[]
Defined in: packages/collection/src/cache.ts:87
Returns live cached values.
Returns
Section titled “Returns”V[]