pure cache

純粋なキャッシュ

自信を持ってキャッシュ

Ultra Fast＆Tiny（約1.28kb gzippip ）インメモリ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
• あなたの変更を文書化する完全な発言でプルリクエストを送信する

クレジット

• 素晴らしいライブラリとREADMEテンプレート用の開発/MITT

ライセンス

MITライセンス©Ganapati vs