Skip to content

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.

K

V

new Cache<K, V>(options?): Cache<K, V>

Defined in: packages/collection/src/cache.ts:27

Creates a cache using the supplied retention policy.

CacheOptions = {}

Cache<K, V>

get size(): number

Defined in: packages/collection/src/cache.ts:52

Number of currently live entries.

number

clear(): void

Defined in: packages/collection/src/cache.ts:73

Invalidates every cached resource.

void


delete(key): boolean

Defined in: packages/collection/src/cache.ts:69

Invalidates one key.

K

boolean


dispose(): void

Defined in: packages/collection/src/cache.ts:85

Kept for compatibility: there is no background sweeper to stop.

void


entries(): [K, V][]

Defined in: packages/collection/src/cache.ts:91

Returns live cached entries.

[K, V][]


get(key): V | undefined

Defined in: packages/collection/src/cache.ts:56

Reads a live entry and marks it most recently used.

K

V | undefined


has(key): boolean

Defined in: packages/collection/src/cache.ts:60

Returns whether a live entry exists.

K

boolean


invalidate(predicate): number

Defined in: packages/collection/src/cache.ts:77

Invalidates every entry matching a predicate.

(value, key) => boolean

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.

K

V

this


sweep(): number

Defined in: packages/collection/src/cache.ts:81

Removes expired entries now and returns the number removed.

number


values(): V[]

Defined in: packages/collection/src/cache.ts:87

Returns live cached values.

V[]