import CacheAdapterNodecache from 'devapt-core-common/js/cache/cache_adapter_node_cache.js'

public class | source

CacheAdapterNodecache

Extends:

CacheAdapter → CacheAdapterNodecache

Cache adapter for node-cache.

Example:

API:
		->constructor(arg_settings={ttl:5000, check_period:1000}) - time unit is milliseconds

		->get(arg_key:string, arg_default):Promise
		->mget(arg_keys:array, arg_default:any|array):Promise
		->has(arg_key:string):Promise
		->set(arg_key:string, arg_value, arg_ttl=undefined):Promise

		->set_ttl(arg_key:string, arg_ttl):Promise
		->get_ttl(arg_key:string):Promise

		->get_keys():Promise
		->remove(arg_keys:string|array):Promise

		->flush():nothing - delete all entries.
		->close():nothing - clear interval timeout for checks.

Constructor Summary

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

Member Summary

Public Members
public	is_cache_adapter_node_cache: boolean Class type flag.

Private Members
private	_engine: NodeCache Cache storage engine.

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.

Inherited Summary

From class CacheAdapter
public	is_cache_adapter: boolean Class type flag.
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 Cache instance to manage cached datas.

Override:

CacheAdapter#constructor

Params:

Name	Type	Attribute	Description
arg_settings	object		cache engine settings.

Return:

nothing

Public Members

public is_cache_adapter_node_cache: boolean source

Class type flag.

Private Members

private _engine: NodeCache source

Cache storage engine.

Public Methods

public close(): Promise source

Close cache engine.

Override:

CacheAdapter#close

Return:

Promise

Promise of undefined.

public flush(): Promise source

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

Override:

CacheAdapter#flush

Return:

Promise

Promise of undefined.

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

Get a cached value.

Override:

CacheAdapter#get

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.

Override:

CacheAdapter#get_keys

Return:

Promise

Promise of keys array.

public get_ttl(arg_key: string): Promise source

Get cached value ttl.

Override:

CacheAdapter#get_ttl

Params:

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

Return:

Promise

Promise of integer|undefined:ttl in milliseconds.

public has(arg_key: string): Promise source

Test if given key has a cached value.

Override:

CacheAdapter#has

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.

Override:

CacheAdapter#mget

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).