api.cache

Подробное описание

Функции для работы с кэшем

api.cache

Открытые члены
	cacheKey ()
	Возвращает ключ кэша Подробнее...
	contains (key)
	Получить признак наличия ключа в кеше Подробнее...
	insert (key, data)
	Вставка данных в кэш по ключу Подробнее...
	remove (key)
	Удаление данных из кеша по ключу Подробнее...
	setCacheKey (key)
	Задает кэш по ключу Подробнее...
	value (key, def)
	Получить значение кэша по ключу, в случае отсутствия будет возвращено значение по умолчанию Подробнее...

Методы

cacheKey ()

cacheKey

(

)

Возвращает ключ кэша

Возвращает

String - Ключ кэша

contains (key)

contains

(

key

)

Получить признак наличия ключа в кеше

Аргументы

key	[String] - ключ кеша

Возвращает

Boolean - Признак наличия ключа в кеше

insert (key, data)

insert	(	key	,
		data
	)

Вставка данных в кэш по ключу

Аргументы

key	[String] - ключ кеша
data	[any] - значение, которое хотим сохранить по ключу

//Пример занесения данных в кэш
function cacheInsert(data, key) {
    api.cache.setCacheKey("TestCache"); // указываем ключ используемого кэша
    api.cache.insert(key, data); // В назначеный TestCache заносим data с ключем key 
}

remove (key)

remove

(

key

)

Удаление данных из кеша по ключу

Аргументы

key	[String] - ключ кеша, по которому хотим удалить данные

setCacheKey (key)

setCacheKey

(

key

)

Задает кэш по ключу

Аргументы

key	[String] - ключ кэша

value (key, def)

value	(	key	,
		def
	)

Получить значение кэша по ключу, в случае отсутствия будет возвращено значение по умолчанию

Аргументы

key	[String] - ключ, по которому хотим получить значение
def	[any] optional - значение по умолчанию

Возвращает

any - значение кеша по ключу

//Пример получения данных из кэша
function cacheValue(key) {
    api.cache.setCacheKey("TestCache"); // указываем ключ используемого кэша
 
    if (api.cache.contains(key)) { // есть ли key в TestCache
        return api.cache.value(key); // получаем данные
    } else {
        api.interactive.info("Ключ " + key + " не найден в кэше");
    }
 
    return false;
}