Interface Cache

Cache Interface

interface Cache {
    clear(): Promise<void>;
    configure(config): CacheConfig;
    createInstance(config): Cache;
    getAllKeys(): Promise<string[]>;
    getCurrentCacheSize(): Promise<number>;
    getItem(key, options?): Promise<any>;
    removeItem(key): Promise<void>;
    setItem(key, value, options?): Promise<void>;
}

Implemented by

StorageCache

Index

Methods

clear configure createInstance getAllKeys getCurrentCacheSize getItem removeItem setItem

Methods

clear

clear(): Promise<void>
Remove all items from cache

Returns Promise<void>

configure

configure(config): CacheConfig
change current configuration
Parameters
- config: CacheConfig
Returns CacheConfig

createInstance

createInstance(config): Cache
create a new instance with customized config
Parameters
- config: CacheConfig
Returns Cache

getAllKeys

getAllKeys(): Promise<string[]>
Get all keys form cache

Returns Promise<string[]>

getCurrentCacheSize

getCurrentCacheSize(): Promise<number>
Get current size of the cache

Returns Promise<number>

getItem

getItem(key, options?): Promise<any>
Get item from cache
Parameters
- key: string
- Optional options: CacheItemOptions
Returns Promise<any>

removeItem

removeItem(key): Promise<void>
Remove item from cache
Parameters
- key: string
Returns Promise<void>

setItem

setItem(key, value, options?): Promise<void>
Put item into cache
Parameters
- key: string
- value: any
- Optional options: CacheItemOptions
Returns Promise<void>