ICache

Description

The interface serves as a foundational structure and set of methods specifically tailored to manage caches, optimizing the performance of the system by efficiently storing and retrieving values, thereby reducing the need for repeated computations.

Instance methods

retrieve

Adds a listener that will be notified when configuration is changed

addChangeListener(context: IContext, key: string): Promise<any>

• context: IContext - (optional) a context to trace execution through call chain.
• key: string - a unique value key.
• returns: Promise<any> - the cached value or null if value wasn’t found.

store

Stores value in the cache with expiration time.

store(context: IContext, key: string, value: any, timeout: number): Promise<any>

• context: IContext - (optional) a context to trace execution through call chain.
• key: string - a unique value key.
• value: any - a value to store.
• timeout: number - expiration timeout in milliseconds.
• returns: Promise<any> - The value that was stored in the cache.

remove

Reads configuration and parameterizes it with given values.

remove(context: IContext, key: string): Promise<void>

• context: IContext - (optional) a context to trace execution through call chain.
• key: string - a unique value key.