pure cache

чистый кеш

Кэш с уверенностью

Ultra Fast & Tiny ( около 1,28 КБ gzipped ) в памяти кэш JavaScript с функцией истечения срока действия кэша в режиме реального времени

Работает в любом среде выполнения JavaScript (узел или браузер)

Оглавление

• Установить
• Основное использование
• События
• API
• Способствовать
• Кредиты
• Лицензия

Установить

Npm

npm install pure-cache

Пряжа

yarn add pure-cache

UMD строить

 < script src =" https://unpkg.com/pure-cache/dist/pure-cache.umd.js " > </ script > 

Основное использование

• Импорт библиотека

   import PureCache from 'pure-cache' ;
  // or const PureCache = require('pure-cache');

• Создайте экземпляр Cachestore

   // Create instance of cache store and set cache expiry timeout to 500ms
  const cacheStore = new PureCache ( { expiryCheckInterval : 500 } ) ;

• Настройка обработчика истечения срока действия

   // Setup a expiry listener, this will be called when data expires
  const onExpiry = ( { key , data : { value , expiryAt } } ) => {
      // Do something with expired key
      console . log ( `Key: ${ key } with value: ${ value } expired at ${ expiryAt } .` ) ;
  } ;
  cacheStore . on ( 'expiry' , onExpiry ) ;

• Поместите/получите данные из Cachestore

   // Put 'bar' data into 'foo' key in cache and configure it to expire after 30s
  cacheStore . put ( 'foo' , 'bar' , 30000 ) ;
  
  // Get 'foo' key value from cache
  cacheStore . get ( 'foo' ) ; // { value: 'bar', addedAt: 1527052395294, expiryAt: 1527052425294 }

• Подождите истекания

   // Wait till expiry time(basically 30+ seconds in this case)
  const wait = t => new Promise ( r => setTimeout ( r , t ) ) ;
  await wait ( 31000 ) ;
  
  // Now the cache will return null value for 'foo' key
  cacheStore . get ( 'foo' ) ; // null

• Очистка слушателей

   // remove listeners after you are done
  cacheStore . off ( 'expiry' , onExpiry ) ;
  
  // IMPORTANT! When done, make sure you cleanup the instance
  cacheStore . dispose ( ) ;

Посмотрен API для расширенного использования.

События

События запускаются, когда такие операции, как Add, Get, удалить, очистить, выполняются на Cachestore или когда кэш истекает.

• истечение

   cacheStore . on ( 'expiry' , ( { key , data : { value , addedAt , expiryAt } } ) => {
      // ...
  } ) ;

• добавлять

   cacheStore . on ( 'add' , ( { key , data : { value , addedAt , expiryAt } } ) => {
      // ...
  } ) ;

• получать

   cacheStore . on ( 'get' , ( { key , data : { value , addedAt , expiryAt } } ) => {
      // ...
  } ) ;

• удалять

   cacheStore . on ( 'remove' , ( { key , data : { value , addedAt , expiryAt } } ) => {
      // ...
  } ) ;

• прозрачный

   cacheStore . on ( 'clear' , ( ) => {
      // ...
  } ) ; 

API

• Чистый кеш
• В память (внутренняя) (внутренняя)

Способствовать

Спасибо, что потратили время, чтобы внести свой вклад, пожалуйста, прочитайте документы и проверьте SRC, чтобы понять, как все работает.

Проблемы отчетности

Нашли проблему? Хотите новую функцию? Прежде всего, посмотрите, сообщили ли о вашей проблеме или идее. Если нет, просто откройте новую ясную и описательную проблему.

Отправка запросов на привлечение

Запросы на привлечение являются наибольшим вкладом, поэтому убедитесь, что они сосредоточены на сфере масштабов и избегайте не связанных коммитов.

• Происходите!
• Клонировать свою вилку: git clone https://github.com/<your-username>/pure-cache
• Перейдите в недавно клонированный каталог: cd pure-cache
• Создайте новую филиал для новой функции: git checkout -b my-new-feature
• Установите инструменты, необходимые для разработки: yarn
• Внесите свои изменения.
• Сделайте свои изменения: git commit -am 'Add some feature'
• Толк к ветке: git push origin my-new-feature
• Отправьте запрос на привлечение с полными замечаниями, документируя ваши изменения

Кредиты

• Разработка/MITT для потрясающей библиотеки и шаблона Readme

Лицензия

Лицензия MIT © Ganapati VS