Interface ICache

Hierarchy

ICache

Index

Methods

addToSet dropKey dropSet getKey readFromSet removeFromSet setKey

Methods

addToSet

addToSet<T>(key: string, value: T): Promise<boolean>
Add a value to a set and create the set if it doesn't exist. Returns a boolean where true means the value was inserted and false means the value already exists in the set.
Type Parameters
- T
Parameters
- key: string
- value: T
Returns Promise<boolean>
- Defined in moirae/core/lib/interfaces/cache.interface.ts:27

dropKey

dropKey(key: string): Promise<void>
Drop a key-value pair
Parameters
- key: string
Returns Promise<void>
- Defined in moirae/core/lib/interfaces/cache.interface.ts:10

dropSet

dropSet(key: string): Promise<void>
Drop set from the cache
Parameters
- key: string
Returns Promise<void>
- Defined in moirae/core/lib/interfaces/cache.interface.ts:31

getKey

getKey<T>(key: string): Promise<T>
Get a value given a key in a key-value pair
Type Parameters
- T
Parameters
- key: string
Returns Promise<T>
- Defined in moirae/core/lib/interfaces/cache.interface.ts:14

readFromSet

readFromSet<T>(key: string, options?: ICacheOptions<T>): Promise<T[]>
Get all values from a set
Type Parameters
- T
Parameters
- key: string
- Optional options: ICacheOptions<T>
Returns Promise<T[]>
- Defined in moirae/core/lib/interfaces/cache.interface.ts:35

removeFromSet

removeFromSet<T>(key: string, value: T): Promise<boolean>
Remove a value from the set if it exists. Returns a boolean where true means the operation was successful and false means the value doesn't exist in the set.
Type Parameters
- T
Parameters
- key: string
- value: T
Returns Promise<boolean>
- Defined in moirae/core/lib/interfaces/cache.interface.ts:41

setKey

setKey<T>(key: string, value: T): Promise<boolean>
Set a key-value pair

Returns
Success or Fail boolean
Type Parameters
- T
Parameters
- key: string
- value: T
Returns Promise<boolean>
- Defined in moirae/core/lib/interfaces/cache.interface.ts:19

Generated using TypeDoc