Class Cache<T>

An abstraction for prioritizing performance over data "freshness"

Type Parameters

T

Implements

ICache<T>

Index

Constructors

Methods

Constructors

constructor

new Cache<T>(
    storage: IGenericStorage,
    cacheLife?: number | ((entry: T) => boolean),
    serializer?: JsonSerializer,
): Cache<T>
Type Parameters
- T
Parameters
- storage: IGenericStorage
  the storage interface used to support caching
- cacheLife: number | ((entry: T) => boolean) = 0
  EITHER 1.) the amount of milliseconds after the cache is created till it is invalidated | leaving the default value (0) will result prevent any auto clearing of cache entries OR 2.) a function defining when the cache is no longer valid; a "false" return will invalidate the cache
- serializer: JsonSerializer = ...
Returns Cache<T>
- Defined in src/Persistence/Cache/Cache.ts:16

Methods

Add

Add(key: string, value: T): Result<null>
Add an entry to the cache at a the given key
Parameters
- key: string
- value: T
Returns Result<null>
Implementation of ICache.Add
- Defined in src/Persistence/Cache/Cache.ts:22

Delete

Delete(key: string): Result<null>
Delete the cached entry at the given key | is safe to call when no entry for the given key exists
Parameters
- key: string
Returns Result<null>
Implementation of ICache.Delete
- Defined in src/Persistence/Cache/Cache.ts:52

Get

Get(key: string, type?: new () => T): null | T
Get the value cached at the given key | returns null when there is no value for the given key
Parameters
- key: string
- Optionaltype: new () => T
Returns null | T
Implementation of ICache.Get
- Defined in src/Persistence/Cache/Cache.ts:33