pure cache

color puro

Caché con confianza

Ultra Fast & Tiny ( alrededor de 1.28 kb GZipped ) en memoria de javascript en memoria Cache con una característica de vencimiento de caché cercano a tiempo real

Funciona en cualquier tiempo de ejecución de JavaScript (nodo o navegador)

Tabla de contenido

• Instalar
• Uso básico
• Eventos
• API
• Contribuir
• Créditos
• Licencia

Instalar

Npm

npm install pure-cache

Hilo

yarn add pure-cache

Umd Build

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

Uso básico

• Biblioteca de importación

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

• Crear instancia de Cachestore

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

• Configuración del controlador de cadena

   // 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 ) ;

• Ponga/obtenga datos de 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 }

• Esperar a la expiración

   // 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

• Oyentes de limpieza

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

API de pago para uso avanzado.

Eventos

Los eventos se activan cuando las operaciones como agregar, obtener, eliminar, borrar se realizan en Cachestore o cuando el caché expira.

• expiración

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

• agregar

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

• conseguir

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

• eliminar

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

• claro

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

API

• Caché puro
• En Memory Experer (interno)

Contribuir

Gracias por tomarse el tiempo para contribuir, lea los documentos y consulte SRC para comprender cómo funcionan las cosas.

Problemas de informes

Encontrado un problema? ¿Quieres una nueva característica? En primer lugar, vea si su problema o idea ya se ha informado. Si no, simplemente abra un nuevo problema claro y descriptivo.

Enviar solicitudes de extracción

Las solicitudes de extracción son las mayores contribuciones, así que asegúrese de que estén enfocadas en el alcance y eviten los compromisos no relacionados.

• ¡Bifurca!
• Clone Your Fork: git clone https://github.com/<your-username>/pure-cache
• Navegue al directorio recién clonado: cd pure-cache
• Cree una nueva rama para la nueva característica: git checkout -b my-new-feature
• Instale las herramientas necesarias para el desarrollo: yarn
• Haga sus cambios.
• Comprometer sus cambios: git commit -am 'Add some feature'
• Push to the Branch: git push origin my-new-feature
• Envíe una solicitud de extracción con comentarios completos que documenten sus cambios

Créditos

• Desarrollar/Mitt para la increíble plantilla de biblioteca y lectura

Licencia

Licencia MIT © Ganapati vs