Class MemoryCache<T>

In-memory cache implementation using a JavaScript Map. Fast and simple, but data is lost when the process exits.

Example

const cache = new MemoryCache<string>({
  defaultTtl: 5000,
  verbose: true,
  logPrefix: '[EntityCache]',
  namespace: 'medical'
});

await cache.set('disease:diabetes', 'Type 2 Diabetes Mellitus');
const result = await cache.get('disease:diabetes');

Type Parameters

T = any
The type of values stored in the cache

Hierarchy (view full)

common.apis.cache.BaseCache<T>
- MemoryCache

Index

Constructors

constructor

new MemoryCache<T>(config?): common.apis.cache.MemoryCache<T>
Creates a new in-memory cache instance.
Type Parameters
- T = any
Parameters
- Optionalconfig: common.apis.cache.CacheConfig
  Cache configuration options
Returns common.apis.cache.MemoryCache<T>
Overrides BaseCache.constructor
- Defined in packages/ts_common/src/apis/cache.ts:1094

Properties

config

config: common.apis.cache.CacheConfig

Cache configuration

logger

logger: any

`Protected`stats

stats: common.apis.cache.CacheStats

Methods

`Protected`buildKey

buildKey(key): string
Protected
Builds a full cache key by combining prefix, namespace, and the provided key.
Parameters
- key: string
  The base cache key
Returns string
The fully qualified cache key
Inherited from BaseCache.buildKey
- Defined in packages/ts_common/src/apis/cache.ts:554

clear

clear(): Promise<void>
Removes all entries from the cache. Must be implemented by concrete cache classes.

Returns Promise<void>
Overrides BaseCache.clear
- Defined in packages/ts_common/src/apis/cache.ts:1193

`Protected`createCacheEntry

createCacheEntry<U>(value, options?): common.apis.cache.CacheEntry<U>
Protected
Creates a cache entry with metadata and expiration information.
Type Parameters
- U
  The type of the value being cached
Parameters
- value: U
  The value to cache
- Optionaloptions: common.apis.cache.CacheSetOptions
  Optional caching configuration
Returns common.apis.cache.CacheEntry<U>
A complete cache entry object
Inherited from BaseCache.createCacheEntry
- Defined in packages/ts_common/src/apis/cache.ts:572

delete

delete(key): Promise<boolean>
Removes a specific key from the cache.
Parameters
- key: string
  The cache key to delete
Returns Promise<boolean>
True if the key was successfully deleted
Overrides BaseCache.delete
- Defined in packages/ts_common/src/apis/cache.ts:1183

get

get(key): Promise<null | T>
Retrieves a value from the memory cache.
Parameters
- key: string
  The cache key to retrieve
Returns Promise<null | T>
The cached value or null if not found or expired
Overrides BaseCache.get
- Defined in packages/ts_common/src/apis/cache.ts:1107

getStats

getStats(): common.apis.cache.CacheStats
Returns a copy of the current cache statistics.

Returns common.apis.cache.CacheStats
Current cache performance statistics
Inherited from BaseCache.getStats
- Defined in packages/ts_common/src/apis/cache.ts:677

has

has(key): Promise<boolean>
Checks if a key exists in the cache and is not expired.
Parameters
- key: string
  The cache key to check
Returns Promise<boolean>
True if the key exists and is valid
Overrides BaseCache.has
- Defined in packages/ts_common/src/apis/cache.ts:1158

`Protected`isExpired

isExpired(entry): boolean
Protected
Checks if a cache entry has expired based on its expiration timestamp.
Parameters
- entry: common.apis.cache.CacheEntry<any>
  The cache entry to check
Returns boolean
True if the entry has expired
Inherited from BaseCache.isExpired
- Defined in packages/ts_common/src/apis/cache.ts:599

keys

keys(): Promise<string[]>
Returns all keys currently stored in the cache. Filters out expired entries and returns the original keys without prefixes.

Returns Promise<string[]>
Array of all cache keys
Overrides BaseCache.keys
- Defined in packages/ts_common/src/apis/cache.ts:1206

`Protected`log

log(message, data?): void
Protected
Logs a message if verbose logging is enabled.
Parameters
- message: string
  The log message
- Optionaldata: any
  Optional additional data to log
Returns void
Inherited from BaseCache.log
- Defined in packages/ts_common/src/apis/cache.ts:651

resetStats

resetStats(): void
Resets all cache statistics to zero.

Returns void
Inherited from BaseCache.resetStats
- Defined in packages/ts_common/src/apis/cache.ts:684

set

set(key, value, options?): Promise<void>
Stores a value in the memory cache.
Parameters
- key: string
  The cache key to store under
- value: T
  The value to cache
- Optionaloptions: common.apis.cache.CacheSetOptions
  Optional caching configuration (TTL, metadata)
Returns Promise<void>
Overrides BaseCache.set
- Defined in packages/ts_common/src/apis/cache.ts:1137

size

size(): Promise<number>
Returns the number of valid (non-expired) entries in the cache.

Returns Promise<number>
Current cache size
Overrides BaseCache.size
- Defined in packages/ts_common/src/apis/cache.ts:1233

`Protected`updateStats

updateStats(operation, context?): void
Protected
Updates cache statistics for performance monitoring.
Parameters
- operation:
      | "set"
      | "delete"
      | "hit"
      | "miss"
  The type of operation that occurred
- Optionalcontext: {
      fullKey?: string;
      key?: string;
      reason?: string;
      [key: string]: any;
  }
  Additional context for hit/miss logging
  - [key: string]: any
  - OptionalfullKey?: string
  - Optionalkey?: string
  - Optionalreason?: string
Returns void
Inherited from BaseCache.updateStats
- Defined in packages/ts_common/src/apis/cache.ts:619

Class MemoryCache<T>

Example

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns common.apis.cache.MemoryCache<T>

Properties

config

logger

Protectedstats

Methods

ProtectedbuildKey

Parameters

Returns string

clear

Returns Promise<void>

ProtectedcreateCacheEntry

Type Parameters

Parameters

Returns common.apis.cache.CacheEntry<U>

delete

Parameters

Returns Promise<boolean>

get

Parameters

Returns Promise<null | T>

getStats

Returns common.apis.cache.CacheStats

has

Parameters

Returns Promise<boolean>

ProtectedisExpired

Parameters

Returns boolean

keys

Returns Promise<string[]>

Protectedlog

Parameters

Returns void

resetStats

Returns void

set

Parameters

Returns Promise<void>

size

Returns Promise<number>

ProtectedupdateStats

Parameters

[key: string]: any

OptionalfullKey?: string

Optionalkey?: string

Optionalreason?: string

Returns void

Settings

On This Page

`Protected`stats

`Protected`buildKey

`Protected`createCacheEntry

`Protected`isExpired

`Protected`log

`Protected`updateStats

`Optional`fullKey?: string

`Optional`key?: string

`Optional`reason?: string