Interface ICache<T>

An abstraction for prioritizing performance over data "freshness"

interface ICache<T> {
    Add(key, value): Result<null>;
    Delete(key): Result<null>;
    Get(key, type?): null | T;
}

Type Parameters

T

Implemented by

Cache

Index

Methods

Methods

Add

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

Delete

Delete(key): 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>
- Defined in src/Persistence/Cache/ICache.ts:23

Get

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

Generated using TypeDoc