Interface ICache

interface ICache {
    setCache(id: string, value: any): void;
    getCached(id: string): any;
    clearCache(id?: string): void;
    getCacheMetrics(): { sets: number; hits: number; misses: number };
}

Hierarchy (View Summary)

ICache
- WorkingContext

Index

Methods

setCache getCached clearCache getCacheMetrics

Methods

setCache

setCache(id: string, value: any): void
Keep a value under a given identifier.
Parameters
- id: string
  the identifier to set,
- value: any
  the value to keep for the identifier.
Returns void
- Defined in src/interfaces.ts:15

getCached

getCached(id: string): any
Get the value kept under a given identifer.
Parameters
- id: string
  the identifer to look for.
Returns any
the value kept under that identifer, or undefined if the id was not found.
- Defined in src/interfaces.ts:22

clearCache

clearCache(id?: string): void
Delete a single identifier and its value, or entirely delete all values.
Parameters
- Optionalid: string
  the identifier to delete. If not provided, the entire cache will be cleared.
Returns void
- Defined in src/interfaces.ts:28

getCacheMetrics

getCacheMetrics(): { sets: number; hits: number; misses: number }
Retrieve metrics for this cache instance. This is mainly a debugging/monitoring method.

Returns { sets: number; hits: number; misses: number }
a metrics object containing sets, hits, and misses.
- Defined in src/interfaces.ts:35