Class BoundedCache<K, V>

BoundedCache

High-performance Map implementation enforcing maximum capacity (LRU) and TTL eviction. Supports static keys (immortal glossary definitions) and date-salt staleness purging.

Type Parameters

K = string
V = string

Hierarchy

Map<K, V>
- BoundedCache

Index

Constructors

constructor

new BoundedCache<K = string, V = string>(
maxSize?: number,
ttl?: number,
): BoundedCache<K, V>
Creates a bounded cache with configurable capacity and entry lifetime.
Type Parameters
- K = string
- V = string
Parameters
- maxSize: number = 1000
  Maximum number of non-static entries retained
- ttl: number = ...
  Default time-to-live for entries in milliseconds
Returns BoundedCache<K, V>
Overrides Map<K, V>.constructor
- Defined in packages/library/src/common/runtime/cache.class.ts:23

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

maxSize

maxSize: number

ttl

ttl: number

`Static` `Readonly`[species]

"[species]": MapConstructor

Accessors

isBoundedCache

get isBoundedCache(): boolean
Returns true to identify this instance as a BoundedCache.

Returns boolean
- Defined in packages/library/src/common/runtime/cache.class.ts:32

size

get size(): number
Returns the number of entries in the cache after evicting expired entries.

Returns number
Overrides Map.size
- Defined in packages/library/src/common/runtime/cache.class.ts:119

Methods

[iterator]

"[iterator]"(): MapIterator<[K, V]>
Returns an iterator of cache entries after evicting expired entries, making the cache iterable.

Returns MapIterator<[K, V]>
Iterator of [key, value] pairs
Overrides Map.[iterator]
- Defined in packages/library/src/common/runtime/cache.class.ts:291

clear

clear(count?: number): void
Purges cache entries. If count is specified, evicts up to count oldest non-static entries. If omitted, clears all entries, including static entries.
Parameters
- Optionalcount: number
  Optional number of entries to evict. If omitted, clears all entries.
Returns void
Overrides Map.clear
- Defined in packages/library/src/common/runtime/cache.class.ts:237

delete

delete(key: K): boolean
Deletes a key from the cache, removing its expiration and static key markers.
Parameters
- key: K
  The cache key to delete
Returns boolean
True if the key was deleted, false if it did not exist
Overrides Map.delete
- Defined in packages/library/src/common/runtime/cache.class.ts:200

deletePrefix

deletePrefix(prefix: string): number
Deletes all cache entries whose keys start with the specified prefix. The prefix comparison is case-insensitive.
Parameters
- prefix: string
  The prefix string to match against cache keys
Returns number
The number of entries deleted
- Defined in packages/library/src/common/runtime/cache.class.ts:214

entries

entries(): MapIterator<[K, V]>
Returns an iterator of cache entries after evicting expired entries.

Returns MapIterator<[K, V]>
Iterator of [key, value] pairs
Overrides Map.entries
- Defined in packages/library/src/common/runtime/cache.class.ts:281

evictExpired

evictExpired(): void
Purges TTL-expired entries.

Returns void
- Defined in packages/library/src/common/runtime/cache.class.ts:51

forEach

forEach(
callbackfn: (value: V, key: K, map: Map<K, V>) => void,
thisArg?: any,
): void
Executes a callback for each cache entry after evicting expired entries.
Parameters
- callbackfn: (value: V, key: K, map: Map<K, V>) => void
  Function to execute for each entry
- OptionalthisArg: any
  Optional value to use as this when executing the callback
Returns void
Overrides Map.forEach
- Defined in packages/library/src/common/runtime/cache.class.ts:130

get

get(key: K): V | undefined
Retrieves a value from the cache by key. Evaluates TTL expiration via #expires specifically for the requested key, and updates LRU ordering by deleting and re-inserting the key in the underlying Map. Leaves the expiration deadline unchanged.
Parameters
- key: K
  The cache key to retrieve
Returns V | undefined
The cached value, or undefined if not found or expired
Overrides Map.get
- Defined in packages/library/src/common/runtime/cache.class.ts:89

getOrInsert

getOrInsert(key: K, defaultValue: V): V
Returns a specified element from the Map object. If no element is associated with the specified key, a new element with the value defaultValue will be inserted into the Map and returned.
Parameters
- key: K
- defaultValue: V
Returns V
The element associated with the specified key, which will be defaultValue if no element previously existed.
Inherited from Map.getOrInsert
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:25

getOrInsertComputed

getOrInsertComputed(key: K, callback: (key: K) => V): V
Returns a specified element from the Map object. If no element is associated with the specified key, the result of passing the specified key to the callback function will be inserted into the Map and returned.
Parameters
- key: K
- callback: (key: K) => V
Returns V
The element associated with the specific key, which will be the newly computed value if no element previously existed.
Inherited from Map.getOrInsertComputed
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:31

has

has(key: K): boolean
Checks if a key exists in the cache and is not expired. Automatically evicts expired entries on access.
Parameters
- key: K
  The cache key to check
Returns boolean
True if the key exists and is not expired, false otherwise
Overrides Map.has
- Defined in packages/library/src/common/runtime/cache.class.ts:108

isStatic

isStatic(key: K): boolean
Check if a key is a static key.
Parameters
- key: K
Returns boolean
- Defined in packages/library/src/common/runtime/cache.class.ts:77

keys

keys(): MapIterator<K>
Returns an iterator of cache keys after evicting expired entries.

Returns MapIterator<K>
Iterator of cache keys
Overrides Map.keys
- Defined in packages/library/src/common/runtime/cache.class.ts:261

set

set(key: K, value: V, ttl?: number): this
Sets a key-value pair in the cache, enforcing LRU eviction. If finite-TTL is configured, entries retain their original absolute expiration deadline unless an explicit ttl override is passed. If the cache exceeds maxSize, the oldest non-static entry is removed.
Parameters
- key: K
  The cache key to set
- value: V
  The value to store
- Optionalttl: number
  Optional custom time-to-live in milliseconds for this specific entry
Returns this
This cache instance for chaining
Overrides Map.set
- Defined in packages/library/src/common/runtime/cache.class.ts:146

setStatic

setStatic(key: K, value: V): this
Register an immortal static key (e.g. business glossary term). Static keys bypass TTL expiration and LRU capacity eviction.
Parameters
- key: K
- value: V
Returns this
- Defined in packages/library/src/common/runtime/cache.class.ts:65

toJSON

toJSON(): Record<string, V>
Returns a plain key-value object of all active non-expired cache entries. Filters out non-string keys to prevent lossy key conversions or collisions (e.g. numeric 1 vs string "1").

Returns Record<string, V>
- Defined in packages/library/src/common/runtime/cache.class.ts:300

values

values(): MapIterator<V>
Returns an iterator of cache values after evicting expired entries.

Returns MapIterator<V>
Iterator of cache values
Overrides Map.values
- Defined in packages/library/src/common/runtime/cache.class.ts:271

`Static`fromEntries

fromEntries<K = string, V = string>(
    entries: Iterable<readonly [K, V]>,
    maxSize?: number,
    ttl?: number,
): BoundedCache<K, V>
Creates a BoundedCache from an iterable of key-value pairs.
Type Parameters
- K = string
- V = string
Parameters
- entries: Iterable<readonly [K, V]>
  Iterable of [key, value] pairs to populate the cache
- maxSize: number = 1000
  Maximum number of entries (default: 1000)
- ttl: number = ...
  Time-to-live in milliseconds (default: 24 hours)
Returns BoundedCache<K, V>
A new BoundedCache instance
- Defined in packages/library/src/common/runtime/cache.class.ts:318

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from Map.groupBy
- Defined in node_modules/typescript/lib/lib.es2024.collection.d.ts:23

Class BoundedCache<K, V>

BoundedCache

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BoundedCache<K, V>

Properties

Readonly[toStringTag]

maxSize

ttl

Static Readonly[species]

Accessors

isBoundedCache

Returns boolean

size

Returns number

Methods

[iterator]

Returns MapIterator<[K, V]>

clear

Parameters

Returns void

delete

Parameters

Returns boolean

deletePrefix

Parameters

Returns number

entries

Returns MapIterator<[K, V]>

evictExpired

Returns void

forEach

Parameters

Returns void

get

Parameters

Returns V | undefined

getOrInsert

Parameters

Returns V

getOrInsertComputed

Parameters

Returns V

has

Parameters

Returns boolean

isStatic

Parameters

Returns boolean

keys

Returns MapIterator<K>

set

Parameters

Returns this

setStatic

Parameters

Returns this

toJSON

Returns Record<string, V>

values

Returns MapIterator<V>

StaticfromEntries

Type Parameters

Parameters

Returns BoundedCache<K, V>

StaticgroupBy

Type Parameters

Parameters

Returns Map<K, T[]>

Settings

On This Page

`Readonly`[toStringTag]

`Static` `Readonly`[species]

`Static`fromEntries

`Static`groupBy