import CacheAdapter from 'devapt-core-common/js/cache/cache_adapter.js'

public class | source

CacheAdapter

Direct Subclass:

CacheAdapterCacheManager, CacheAdapterNodecache

CacheAdapter base class.

Example:

API:
		->get(arg_key:string, arg_default):Promise - get a cached value with its key.
		->mget(arg_keys:array, arg_default:any|array):Promise - get cached values with their keys.
		->has(arg_key:string):Promise - testif a cached value exists with given key.
		->set(arg_key:string, arg_value, arg_ttl=undefined):Promise - set a cached value with its key and ttl.
		->set_ttl(arg_key:string, arg_ttl):Promise - set cached value ttl.
		->get_ttl(arg_key:string):Promise - get cached value ttl.
		->get_keys():Promise - get all cached values keys.
		->remove(arg_key:string|array):Promise - remove a cached value.
		->flush():nothing - delete all entries.
		->close():nothing - clear interval timeout for checks.

Constructor Summary

Public Constructor
public	constructor(arg_settings: object): nothing Create CacheAdapter instance to manage cached datas.

Member Summary

Public Members
public	is_cache_adapter: boolean Class type flag.

Method Summary

Public Methods
public	close(): Promise Close cache engine.
public	flush(): Promise Flush all cached values (clear interval timeout for checks).
public	get(arg_key: string, arg_default: any): Promise Get a cached value.
public	get_keys(): Promise Get cached keys.
public	get_ttl(arg_key: string): Promise Get cached value ttl.
public	has(arg_key: string): Promise Test if given key has a cached value.
public	mget(arg_keys: array, arg_default: any): Promise Get a cached value.
public	remove(arg_keys: string \| array): Promise Remove a cached value.
public	set(arg_key: string, arg_value: any, arg_ttl: integer): Promise Set a cached value with given key.
public	set_ttl(arg_key: string, arg_ttl: integer): Promise Set cached value ttl.

Public Constructors

public constructor(arg_settings: object): nothing source

Create CacheAdapter instance to manage cached datas.

Params:

Name	Type	Attribute	Description
arg_settings	object		cache engine settings.

Return:

nothing

Public Members

public is_cache_adapter: boolean source

Class type flag.

Public Methods

public close(): Promise source

Close cache engine.

Return:

Promise

Promise of undefined.

public flush(): Promise source

Flush all cached values (clear interval timeout for checks).

Return:

Promise

Promise of undefined.

public get(arg_key: string, arg_default: any): Promise source

Get a cached value.

Params:

Name	Type	Attribute	Description
arg_key	string		key string to retrieve the value.
arg_default	any		returned default value if the key is not found (optional) (default:undefined).

Return:

Promise

Promise of cached value or undefined.

public get_keys(): Promise source

Get cached keys.

Return:

Promise

Promise of keys array.

public get_ttl(arg_key: string): Promise source

Get cached value ttl.

Params:

Name	Type	Attribute	Description
arg_key	string		key string to retrieve the value.

Return:

Promise

Promise of integer|undefined.

public has(arg_key: string): Promise source

Test if given key has a cached value.

Params:

Name	Type	Attribute	Description
arg_key	string		key string to retrieve the value.

Return:

Promise

Promise of cached value or undefined.

public mget(arg_keys: array, arg_default: any): Promise source

Get a cached value.

Params:

Name	Type	Attribute	Description
arg_keys	array		key strings to retrieve the values.
arg_default	any		returned default value if the key is not found (optional) (default:undefined).

Return:

Promise

Promise of cached value or undefined array.

public remove(arg_keys: string | array): Promise source

Remove a cached value.

Params:

Name	Type	Attribute	Description
arg_keys	string \| array		value key string or array.

Return:

Promise

Promise of undefined.

public set(arg_key: string, arg_value: any, arg_ttl: integer): Promise source

Set a cached value with given key.

Params:

Name	Type	Attribute	Description
arg_key	string		key string to retrieve the value.
arg_value	any		value to cache.
arg_ttl	integer		time to leave for cached value.

Return:

Promise

Promise of nothing.

public set_ttl(arg_key: string, arg_ttl: integer): Promise source

Set cached value ttl.

Params:

Name	Type	Attribute	Description
arg_key	string		key string to retrieve the value.
arg_ttl	integer		time to leave for cached value.

Return:

Promise

Promise of nothing.