Class InMemoryCache

Hierarchy

InMemoryCache
- NoCache

Index

Constructors

Properties

cache ttlDefault

Methods

clear get getVal invalidate keys set shutdown

Constructors

constructor

new InMemoryCache(ttl: 0 | Seconds, cache?: NodeCache): InMemoryCache
Parameters
- ttl: 0 | Seconds
  
  The default time to live in seconds
- cache: NodeCache = ...
  
  The cache engine. It must extend NodeCache
Returns InMemoryCache
- Defined in packages/cardano-services/src/InMemoryCache/InMemoryCache.ts:16

Properties

`Protected` cache

cache: NodeCache

`Protected` ttlDefault

ttlDefault: number

Methods

clear

clear(): void
Clear the whole data and reset the stats

Returns void
- Defined in packages/cardano-services/src/InMemoryCache/InMemoryCache.ts:90

get

get<T>(key: Key, asyncAction: AsyncAction<T>, ttl?: number): Promise<T>
Get a cached key value, if not found execute db query and cache the result with that key

Returns
The value stored with the key
Type Parameters
- T
Parameters
- key: Key
  
  Cache key
- asyncAction: AsyncAction<T>
  
  Async function to get the value
- ttl: number = ...
  
  The time to live in seconds
Returns Promise<T>
- Defined in packages/cardano-services/src/InMemoryCache/InMemoryCache.ts:29

getVal

getVal<T>(key: Key): undefined | T
Get a cached key

Returns
The value stored in the key
Type Parameters
- T
Parameters
- key: Key
  
  Cache key
Returns undefined | T
- Defined in packages/cardano-services/src/InMemoryCache/InMemoryCache.ts:50

invalidate

invalidate(keys: Key | Key[]): void
Invalidate cached values
Parameters
- keys: Key | Key[]
  
  cache key to delete or a array of cache keys
Returns void
- Defined in packages/cardano-services/src/InMemoryCache/InMemoryCache.ts:71

keys

keys(): string[]
List all keys within this cache

Returns
An array of all keys

Returns string[]
- Defined in packages/cardano-services/src/InMemoryCache/InMemoryCache.ts:80

set

set<T>(key: Key, value: T, ttl?: number): boolean
Set a cached key

Returns
The success state of the operation
Type Parameters
- T
Parameters
- key: Key
  
  Cache key
- value: T
  
  A value to cache
- ttl: number = ...
  
  The time to live in seconds
Returns boolean
- Defined in packages/cardano-services/src/InMemoryCache/InMemoryCache.ts:62

shutdown

shutdown(): void
Clear the interval timeout which is set on check period option. Default: 600

Returns void
- Defined in packages/cardano-services/src/InMemoryCache/InMemoryCache.ts:85

Generated using TypeDoc