Class InMemoryCache

Customized in-memory cache with LRU implemented

member: cacheObj - object which store items
member: cacheList - list of keys in the cache with LRU
member: curSizeInBytes - current size of the cache
member: maxPriority - max of the priority
member: cacheSizeLimit - the limit of cache size

Hierarchy

StorageCache
- InMemoryCache

Implements

any

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InMemoryCache(config?: CacheConfig): InMemoryCache

Overrides StorageCache.constructor
- Defined in cache/src/InMemoryCache.ts:39
initialize the cache

Parameters
- Optional config: CacheConfig
  
  the configuration of the cache
Returns InMemoryCache

Properties

Protected cacheCurSizeKey

cacheCurSizeKey: string

Protected config

config: CacheConfig

Methods

clear

clear(): void

- Defined in cache/src/InMemoryCache.ts:294
clear the entire cache

Returns void

configure

configure(config?: CacheConfig): CacheConfig

Inherited from StorageCache.configure
- Defined in cache/src/StorageCache.ts:128
set cache with customized configuration

Parameters
- Optional config: CacheConfig
  
  customized configuration
Returns CacheConfig
- the current configuration

createInstance

createInstance(config: CacheConfig): ICache

- Defined in cache/src/InMemoryCache.ts:329
Return a new instance of cache with customized configuration.

Parameters
- config: CacheConfig
  
  the customized configuration
Returns ICache

Protected fillCacheItem

fillCacheItem(key: string, value: any | number | string | boolean, options: CacheItemOptions): CacheItem

Inherited from StorageCache.fillCacheItem
- Defined in cache/src/StorageCache.ts:101
produce a JSON object with meta-data and data value

Parameters
- key: string
- value: any | number | string | boolean
  
  the value of the item
- options: CacheItemOptions
  
  optional, the specified meta-data
Returns CacheItem
- the item which has the meta-data and the value

getAllKeys

getAllKeys(): string[]

- Defined in cache/src/InMemoryCache.ts:305
Return all the keys in the cache.

Returns string[]

getCacheCurSize

getCacheCurSize(): number

- Defined in cache/src/InMemoryCache.ts:321
return the current size of the cache

Returns number

the current size of the cache

getItem

getItem(key: string, options?: CacheItemOptions): any

- Defined in cache/src/InMemoryCache.ts:242
Get item from cache. It will return null if item doesn’t exist or it has been expired. If you specified callback function in the options, then the function will be executed if no such item in the cache and finally put the return value into cache. Please make sure the callback function will return the value you want to put into the cache. The cache will abort output a warning: If the key is invalid

Parameters
- key: string
  
  the key of the item
- Optional options: CacheItemOptions
  
  the options of callback function
Returns any

getModuleName

getModuleName(): string

Inherited from StorageCache.getModuleName
- Defined in cache/src/StorageCache.ts:44
Returns string

removeItem

removeItem(key: string): void

- Defined in cache/src/InMemoryCache.ts:281
remove item from the cache

Parameters
- key: string
  
  the key of the item
Returns void

setItem

setItem(key: string, value: any | string | number | boolean, options?: CacheItemOptions): void

- Defined in cache/src/InMemoryCache.ts:175
- Set item into cache. You can put number, string, boolean or object. The cache will first check whether has the same key. If it has, it will delete the old item and then put the new item in The cache will pop out items if it is full You can specify the cache item options. The cache will abort and output a warning: If the key is invalid If the size of the item exceeds itemMaxSize. If the value is undefined If incorrect cache item configuration If error happened with browser storage
throws

if the item is too big which exceeds the limit of single item size

throws

if the key is invalid
Parameters
- key: string
  
  the key of the item
- value: any | string | number | boolean
  
  the value of the item
- Optional options: CacheItemOptions
  
  optional, the specified meta-data
Returns void