cache-io

CACHE-IO

Простой модуль кэш-памяти

Инициализация / Начало работы

Установка модуля

npm install cache-io --save

Инициализация одного экземпляра

'use strict';

const Cache = require('cache-io');

const cache = new Cache;

Конфигурация модуля

В конструктор можно передать параметры

expires

Тип: number

По умолчанию: 60

Стандартное время истечений таймера в секундах

prolong

Тип: boolean

По умолчанию: true

Нужно ли обновлять таймер при использование метода get

const cache = new Cache({
	expires: 60 * 30,
	prolong: false
});

Установка значения в кэш

Метод set принимает два аргумента

Первый аргумент

Тип: string или object

Ключ кэша, может быть передан объект с обязательным свойством key

Второй аргумент

Тип: object

Параметры установки кэша, может быть передан в первый аргумент с обязательным свойством key. Полное описание возможных свойств объекта ниже

======

Объект с аргументами

key

Тип: string

Ключ кэша, обязателен если объект передан первым аргументом

value

Тип: mixed

Значение которое хранится в кэше, оно так же возвращается при использование текущего метода тем самым ссылаясь на него

Если передать функцию вызывается при необходимости установить кэш

expires

Тип: integer

Время в секундах когда кэш истечёт, можно не указывать и использовать значение по умолчанию

remove

Тип: function

Функция которая вызывается при истечёние времени кэша

В функцию приходят аргументы ключ и значение (key,value)

cache.set(<key>,{
	value: <mixed>
}); // -> mixed

/* Или например так */

cache.set({
	key: <key>,
	value: <mixed>,
	expires: 60 * 30, // 1:30 полтора часа
	remove: (key,value) => {
		console.log('Cache expired:',key,'-',value);
	}
}); // -> mixed

Получение значения в кэш

Метод get принимает два аргумента

Первый аргумент

Тип: string или object

Ключ кэша, может быть передан объект с обязательным свойством key

Второй аргумент

Тип: object

Объект который наследует параметры из метода set и добавляя свои, подробнее ниже

======

Объект с аргументами

Полностью наследует из метода set

default

Тип: boolean

По умлочанию: false

Если true вместо установки нового кэша, возвращает свойство value или null

update

Тип: boolean

По умолчанию: наследует настройку prolong в конструкторе

Позволяет обновить значение таймера или же наоборот оставить всё как есть

cache.get(<key>,{
	value: <mixed>,
	expires: 10,
	remove: (key,value) => {
		console.log('Cache expired:',key,'-',value);
	}
}); // -> mixed

/* Или вернуть свойство value без установки значения кэша */

cache.get(<key>,{
	value: <mixed>,
	default: true
}); // -> mixed или null

Обновление таймера кэша

Обноваляет таймер кэша, используется в методе get

Первый аргумент

Тип: string

Ключ кэша, при удачном обновление таймера true, если объект уже удалён или отсутствует false

cache.update(<Key>); // -> boolean

Удаления значения в кэша

Удаляет старое значение в кэше, вызывает при использование метода set

Первый аргумент

Тип: string

Ключ кэша, при удачном удаление true, если объект уже удалён или отсутствует false

cache.remove(<Key>); // -> boolean

Полна очистка кэша

Удаляет все ключи кэша, а так же будут вызваны функции remove если были установлены в set

cache.clear(); // -> this

Проверка кэша на наличие

Первый аргумент

Тип: string

Ключ кэша

cache.has(<Key>); // -> boolean

Получение списка ключей кэша

cache.keys(); // -> array