Введение

Кэшируйте данные с помощью TTL. Используя этот пакет в node.js и браузере.

Установка

Через npm:

npm install cache-bucket

Или через yarn:

yarn add cache-bucket

Поддержка

Node.js

Включены FileCache и MemoryCache.

Обратите внимание, что CacheFile будет касаться файла как хранилища. Путь к файлу по умолчанию: ./.filecache

// На основе файла
import {cache} из 'cache-bucket/file-cache';

// На основе памяти
import {cache} из 'cache-bucket/memory-cache';

Браузер

Включены LocalCache, SessionCache и MemoryCache.

Обратите внимание, LocalCache основан на localStorage, а SessionCache — на sessionStorage.

// На основе памяти
import {cache} из 'cache-bucket/memory-cache';

// На основе localStorage
import {cache} из 'cache-bucket/local-cache';

// На основе sessionStorage
import {cache} из 'cache-bucket/session-cache';

Методы

get(key: string, defaultValue?: any) => any

Получите кэш по ключу.

Если кэш пуст, будет использовано значение defaultValue. Если параметр defaultValue отсутствует, метод вернёт null.

cache.get('foo'); // null
cache.get('foo', 'default-bar'); // default-bar

set(key: string, value: any, duration?: number) => void

Установите данные кэша.

Тип параметра value может быть string, number, object, array. Данные кэша истекут через миллисекунды, когда вы укажете длительность.

cache.set('foo', 'bar');
cache.set('obj', {pkg: 'cache-bucket'});

// Истечёт через 3 секунды.
cache.set('array', ['cache', 'bucket'], 3000);

getOrSet(key: string, onEmpty: () => any, duration?: number) => any

Получите данные кэша.

Когда данные кэша отсутствуют, метод немедленно установит данные. А затем вернёт их.

cache.getOrSet('foo', () => {
  return 'bar';
}); // bar

add(key: string, value: any, duration?: number) => boolean

Установите данные кэша, если ключ не существует.

cache.add('foo', 'bar'); // true
cache.add('foo', 'new-bar'); // false

remove(key: string) => void

Удалите данные кэша.

cache.remove('foo');

clearExpired() => void

Очистите все истёкшие данные кэша

cache.clearExpired();

clearAll() => void

Очистите все данные.

cache.clearAll();

Дополнительно

Создание нескольких экземпляров

import {MemoryCache} from 'cache-bucket/memory-cache';

const cache = new MemoryCache();

cache.set('foo', 'bar');
cache.get('foo'); // bar

import {FileCache} from 'cache-bucket/file-cache';

const cache = new FileCache('./.new-cachefile');

cache.set('foo', 'bar');
cache.get('foo'); // bar

Конфигурация

Вы можете выбрать файл, в который хотите поместить данные при использовании FileCache. Просто создайте конфигурационный файл cache-bucekt.json в корне проекта.

{
  "defaultFilePath": "./.custom-cache-file"
}