\n\nIn memory cache for node and the browser that supports `lru` and `ttl` algorithms.\n\nItems in the cache will move to the back queue when accessed and any key can optionally have an expiry time.\n\n## Installation\n\n\n#### Npm\n```console\nnpm install receptacle\n```\n\n#### [Download](https://raw.githubusercontent.com/DylanPiercey/receptacle/master/dist/receptacle.js)\n```html\n\n\n```\n\n## Example\n\n```js\nvar Receptacle = require('receptacle');\nvar cache = new Receptacle({ max: 100 }); // Create a cache with max 100 items.\n\ncache.set(\"item\", 1, { ttl: 100 }); //-> Add item to cache (expire in 100ms).\ncache.get(\"item\"); //-> 1\ncache.has(\"item\"); //-> true\ncache.expire(\"item\", 50); //-> Expire in 50ms (instead of 100).\ncache.delete(\"item\"); //-> Delete item right away.\ncache.clear(); //-> Empty the cache.\n\n// You can also use the \"refresh\" option to automatically reset a keys expiration when accessed.\ncache.set(\"item\", 1, { ttl: 100, refresh: true });\n// 50ms later\ncache.get(\"item\"); // Resets timer back to 100ms.\n\n// And store meta data about values.\ncache.set(\"item\", 1, { meta: { custom: 1 } });\n// Then retrieve it.\ncache.meta(\"item\"); //-> { custom: 1 }\n```\n\n## Serialization\nYou can easily serialize and rehydrate your cache as JSON.\n\n```js\nvar Receptacle = require('receptacle');\nvar cache = new Receptacle({ max: 5 }); // Create a cache with max 5 items.\n\ncache.set(\"a\", 1, { ttl: 1000 });\n\nvar serialized = JSON.stringify(cache); //-> '{ \"max\": 5, \"items\": [...] }'\n\n// Create a cache from the json which will retain all ttl information (and remove any keys that have expired).\nvar newCacheFromJSON = new Receptacle(JSON.parse(serialized));\n\n```\n\n## API\n\n###`Receptacle({ max=Infinity, items=[], id=# })`\nCreate a new cache.\n\n###`#id`\nEach cache is assigned a unique id for organizing, you can optionally provide an id during instanciation.\n\n###`#max`\nGet the maximum size of the cache (default of Infinity).\n\n###`#size`\nGet the current number of items in the cache.\n\n###`#has(key)`\nCheck if a key is in the cache, even if it's undefined.\n\n###`#get(key)`\nRetreive a key from the cache.\n\n###`#meta(key)`\nIf a meta option was used with setting an item in the cache it will be returned.\n\n###`#set(key, value, options)`\nSet a key in the cache, optionally setting a `ttl` option that will cause the value to expire.\nIf a `refresh` option is `true` the ttl will automatically reset when the `key` is accessed.\n\n###`#delete(key)`\nImmediately remove a key from the cache.\n\n###`#expire(key, [ms=0])`\nUpdate the expire time for a key. You can also use any valid [ms](https://github.com/rauchg/ms.js) string for a timeout.\n\n###`#clear()`\nRemove all keys from the cache.\n\n---\n\n### Contributions\n\n* Use `npm test` to run tests.\n\nPlease feel free to create a PR!\n","maintainers":[{"email":"pierceydylan@gmail.com","name":"dylanpiercey"}],"time":{"modified":"2022-06-26T09:30:05.273Z","created":"2015-11-19T02:05:29.429Z","0.1.0":"2015-11-19T02:05:29.429Z","0.1.1":"2015-11-19T03:26:23.381Z","0.1.2":"2015-11-21T02:19:49.485Z","0.2.0":"2015-12-19T16:44:03.366Z","0.2.1":"2015-12-19T18:59:59.287Z","0.3.0":"2015-12-19T20:07:52.754Z","1.0.0":"2016-05-10T21:34:59.712Z","1.0.1":"2016-10-11T19:19:23.024Z","1.0.2":"2016-10-11T23:11:14.186Z","1.0.3":"2016-10-12T03:19:33.223Z","1.0.4":"2016-12-29T23:09:29.298Z","1.0.5":"2016-12-29T23:15:43.770Z","1.1.0":"2017-01-12T18:21:57.046Z","1.3.0":"2017-04-14T17:21:33.769Z","1.3.1":"2018-06-13T15:47:29.711Z","1.3.2":"2018-06-13T15:48:21.194Z"},"homepage":"https://github.com/DylanPiercey/receptacle","keywords":["cache","expires","lru","map","memory","receptacle","ttl"],"repository":{"type":"git","url":"git+https://github.com/DylanPiercey/receptacle.git"},"author":{"name":"Dylan Piercey","email":"pierceydylan@gmail.com"},"bugs":{"url":"https://github.com/DylanPiercey/receptacle/issues"},"license":"MIT","readmeFilename":"README.md"}
![\"API](\"https://img.shields.io/badge/stability-stable-brightgreen.svg?style=flat-square\"){kind=icon}
\n \n \n \n ![\"Standard\"/](\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square\"){kind=icon}
\n \n \n \n ![\"NPM](\"https://img.shields.io/npm/v/receptacle.svg?style=flat-square\")
\n \n \n \n ![\"Build](\"https://img.shields.io/travis/DylanPiercey/receptacle.svg?style=flat-square\")
\n \n \n \n ![\"Test](\"https://img.shields.io/coveralls/DylanPiercey/receptacle.svg?style=flat-square\")
\n \n \n \n ![\"Downloads\"/](\"https://img.shields.io/npm/dm/receptacle.svg?style=flat-square\")
\n \n \n \n ![\"Gitter](\"https://img.shields.io/gitter/room/DylanPiercey/receptacle.svg?style=flat-square\")
\n \n