\n\n## Cache storage\n\n[](https://app.travis-ci.com/HQarroum/timed-cache)\n[](https://www.codefactor.io/repository/github/hqarroum/timed-cache)\n[](https://deepsource.io/gh/HQarroum/timed-cache/?ref=repository-badge)\n\nA minimalist time-based caching system.\n\nThis storage module evicts cached key/value pairs based on their time-to-live.\n\nCurrent version: **2.0.0**\n\n## Install\n\n```bash\nnpm install --save timed-cache\n```\n\n## Usage\n\n### Import the cache module\n\n`timed-cache` is distributed as an ESM module that you can import in your implementation.\n\n```javascript\nimport Cache from 'timed-cache';\n```\n\n### Creating the cache module\n\nBasic operations you can perform on an instance of a `Cache` are insertion, retrieval and removal of key/value pairs.\n\nTo do so, you will need to create a new instance of the cache, by calling its constructor :\n\n```javascript\nconst cache = new Cache();\n```\n\nNote that by default, a key/value pair will be held by the cache storage for `60` seconds before being evicted.\n\nIt is however possible to specify what default value you would like the TTL to have when creating the storage :\n\n```javascript\n// The TTL is always expressed in milliseconds.\n// In this case it will be equal to `5` minutes.\nconst cache = new Cache({ defaultTtl: 300 * 1000 });\n```\n\nYou will then be able to interact with the storage by retrieving and inserting data.\n\n### Basic insertions\n\nYou insert a key/value pair into the storage by using the `.put` primitive and retrieve a value given its key identifier using the `.get` primitive.\n\nHere is an example of inserting values associated with a string key :\n\n```javascript\ncache.put('bar', 'baz');\ncache.put('foo', { foo: 'bar' });\ncache.put('qux', 42);\n```\n\nIt is then possible to retrieve the cached values using their associated keys :\n\n```javascript\ncache.get('bar'); // Returns 'baz'\ncache.get('foo'); // Returns the object { foo: 'bar' }\n```\n\nIt is also possible to use an object as a key as long as it is serializable using [`JSON.stringify`](https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Objets_globaux/JSON/stringify) :\n\n```javascript\ncache.put({ foo: 'bar' }, { bar: 'baz' });\ncache.get({ foo: 'bar' }); // Returns the object { bar: 'baz' }\n```\n\nNote that inserting a value already associated with the inserted key will cause the previous value to be overwritten, and the TTL to be reset.\n\n### Customizing elements TTL\n\nYou can customize the time-to-live value of a key/value pair at insertion time using the third optional argument to `.put` :\n\n```javascript\n// Example of an insertion using a TTL expressed in milliseconds.\ncache.put('foo', 'bar', { ttl: 5 * 1000 });\n```\n\nIt is also possible to define a callback for each inserted key/value pair to be informed when it is actually evicted from the storage :\n\n```javascript\ncache.put('baz', 'bar', {\n ttl: 5 * 1000,\n callback: (key, value) => console.log(`${key} ${value} evicted !`)\n});\n```\n\n### Element removal\n\nIt is possible to remove a cache entry before its time-to-live is reached, by using the `.remove` primitive :\n\n```javascript\ncache.put('foo', 'bar', {\n callback: (key, value) => console.log(`${key} ${value} removed !`)\n});\n\ncache.remove('foo');\n```\n\nIn this case, the callback passed to a `.put` will be called if the user removed the inserted entry.\n\n## License\n[](https://app.fossa.io/projects/git%2Bgithub.com%2FHQarroum%2Ftimed-cache?ref=badge_large)\n","maintainers":[{"name":"hqm","email":"hqm.post@gmail.com"}],"time":{"modified":"2022-06-27T06:46:27.002Z","created":"2015-09-08T14:52:16.076Z","1.0.3":"2015-09-08T14:52:16.076Z","1.0.4":"2015-10-23T13:11:21.068Z","1.0.5":"2015-10-23T14:03:13.881Z","1.1.0":"2017-05-26T18:39:29.114Z","1.1.1":"2018-10-30T14:00:49.122Z","1.1.2":"2019-07-10T14:31:33.728Z","1.1.3":"2020-01-27T15:23:28.612Z","1.1.4":"2020-10-13T16:24:08.636Z","1.1.5":"2021-06-01T14:47:21.918Z","2.0.0":"2022-06-25T21:48:46.858Z"},"keywords":["timed","cache","storage"],"repository":{"type":"git","url":"git+https://github.com/HQarroum/timed-cache.git"},"author":{"name":"Halim Qarroum"},"bugs":{"url":"https://github.com/HQarroum/timed-cache/issues"},"license":"MIT","readmeFilename":"README.md","homepage":"https://github.com/HQarroum/timed-cache#readme"}
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/4/49/Applications-database.svg/240px-Applications-database.svg.png\")
\n