StorageCache | amplify-js

Initialization of the cache

Hierarchy

StorageCache

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StorageCache(config: CacheConfig): StorageCache

- Defined in packages/cache/src/StorageCache.ts:17
Initialize the cache

Parameters
- config: CacheConfig
  
  the configuration of the cache
Returns StorageCache

Properties

Protected cacheCurSizeKey

cacheCurSizeKey: string

Protected config

config: CacheConfig

Methods

configure

configure(config?: CacheConfig): CacheConfig

- Defined in packages/cache/src/StorageCache.ts:132
set cache with customized configuration

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

Protected fillCacheItem

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

- Defined in packages/cache/src/StorageCache.ts:103
produce a JSON object with meta-data and data value

Parameters
- key: string
- value: object | 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

getModuleName

getModuleName(): string

- Defined in packages/cache/src/StorageCache.ts:29
Returns string