![\"Keyv](\"./logo.svg\" "\\"Keyv"){kind=logo}
This project is part of the Keyv suite.
\n\n![\"Travis\"](\"https://img.shields.io/travis/e0ipso/keyv-lru.svg?style=flat-square\")
![\"Coverage\"](\"https://img.shields.io/coveralls/github/e0ipso/keyv-lru.svg?style=flat-square\")
In order to use LRU as your store in Keyv you will need to:
\nInstall this module in your project:
\n\nnpm install @appigram/keyv-lru\nThis module is based on the tiny-lru\nmodule. This is one of the best performing libraries for LRU storages.
Create your Keyv object by executing:
\n\n```js\nimport { KeyvLru, KeyvLruManagedTtl } from '@appigram/keyv-lru';\n\nconst options = {\n max: 1000,\n notify: false,\n ttl: 0,\n expire: 0,\n};\nconst keyvLru = new KeyvLru(options);\nconst keyvLruManagedTtl = new KeyvLruManagedTtl(options);\n```\nSee tiny-lru to learn about the\navailable options.
KeyvLruManagedTtl uses a managed TTL strategy instead of timers. This is useful\nfor serverless architectures. tiny-lru expires entries based on timers, that\nmeans that the event loop is not empty when the lambda function is finished.\nThat blocks the end of the execution.
\nThis implementation will store the expiration time along with the cached data\nand it will deleter expired items upon retrieval. Alternatively there is an\nevictExpired() method that will evict all the expired items.
Even when not using tiny-lru‘s built-in expiration system based on timers, we\nstill benefit a lot from the LRU store.
keyv-lru is MIT licensed.
\n","readmeFilename":"README.md"}