{"_id":"memoizeasync","_rev":"480482","name":"memoizeasync","description":"Helper for memoizing async functions and methods","dist-tags":{"latest":"1.1.0"},"maintainers":[{"name":"papandreou","email":"andreas@one.com"}],"time":{"modified":"2021-08-05T09:34:20.000Z","created":"2012-12-11T22:49:10.139Z","1.1.0":"2017-12-27T21:59:18.619Z","1.0.0":"2017-02-20T13:16:11.821Z","0.9.0":"2016-02-29T14:23:42.172Z","0.8.0":"2014-11-17T10:04:08.645Z","0.7.0":"2014-10-17T03:03:10.813Z","0.6.0":"2014-04-26T21:23:26.954Z","0.5.3":"2014-04-26T21:20:28.270Z","0.5.2":"2014-02-18T14:48:50.887Z","0.5.0":"2014-02-17T14:14:33.558Z","0.5.1":"2014-02-17T14:14:27.502Z","0.4.2":"2013-10-06T21:27:22.643Z","0.4.1":"2013-10-06T18:23:05.848Z","0.4.0":"2013-10-06T16:11:36.903Z","0.3.1":"2013-09-06T22:09:27.894Z","0.3.0":"2013-08-27T20:49:30.083Z","0.1.1":"2013-04-03T21:52:03.458Z","0.1.0":"2013-04-03T12:13:51.900Z","0.0.1":"2012-12-11T22:49:10.139Z"},"users":{"farskipper":true},"author":{"name":"Andreas Lind","email":"andreas@one.com"},"repository":{"type":"git","url":"git://github.com/papandreou/node-memoizeasync.git"},"versions":{"1.1.0":{"name":"memoizeasync","version":"1.1.0","description":"Helper for memoizing async functions and methods","main":"lib/memoizeAsync.js","directories":{"test":"test"},"dependencies":{"lru-cache":"2.5.0","passerror":"1.1.1"},"devDependencies":{"async":"^2.1.5","coveralls":"^2.11.16","eslint":"^3.15.0","eslint-config-onelint":"^2.0.0","mocha":"^3.2.0","nyc":"^10.1.2","sinon":"^1.17.7","unexpected":"^10.26.0","unexpected-sinon":"^10.7.0"},"scripts":{"lint":"eslint .","test":"mocha","travis":"npm test && npm run lint && npm run coverage && (the\ncustom argumentsStringifier test for another example.\n\n\n### Purging and expiring memoized values ###\n\nYou can forcefully clear a specific memoized value using the `purge`\nmethod on the memoizer:\n\n```javascript\nvar memoized = memoizeAsync(function functionToMemoize(foo, cb) {\n // ...\n cb(null, theResult);\n});\nmemoized(123, function (err, value) {\n memoized.purge(123);\n});\n```\n\n`memoized.purgeAll()` clears all memoized results.\n\nYou can also specify a custom ttl (in milliseconds) on the memoized\nresults:\n\n```javascript\nvar memoized = memoizeAsync(function functionToMemoize(cb) {\n // ...\n cb(null, theResult);\n}, {maxAge: 1000});\n```\n\nIn the above example the memoized value will be considered stale one\nsecond after it has been computed, and it will be recomputed next time\n`memoizeAsync` is invoked with the same arguments.\n\n`memoizeAsync` uses node-lru-cache to\nstore the memoized values, and it accepts the same parameters in the\n`options` object. If provided, the `length` function will be wrapped\nso it's called with the same arguments as the callback to the memoized\nfunction:\n\n```javascript\nvar fs = require('fs'),\n memoizedFsReadFile = memoizeAsync(fs.readFile, {\n max: 1000000,\n length: function (err, body) {\n return body.length;\n },\n maxAge: 1000\n });\n```\n\nThe LRU instance is exposed in the `cache` property of the memoized\nfunction in case you need to access it. Note that the values stored in\nthe cache are arrays of parameters provided to the callback by the\nmemoized function. In most cases that will be `[err, result]`:\n\n\n```javascript\nvar numMemoizedErrors = 0;\nmemoized.cache.values().forEach(function (resultCallbackParams) {\n if (resultCallbackParams[0]) {\n numMemoizedErrors += 1;\n }\n});\n```\n\nBesides the maxAge option that is provided by the LRU module, the\nmemoizer is augmented with a refreshAge option. When the memoizer\nis asked for a value which is post its refreshAge, it will start\nfetching a new value, while in the meantime it will return the\nvalue.\n\n```javascript\nvar memoizedFsReadFile = memoizeAsync(slowAsyncMethod, {\n refreshAge: 900,\n maxAge: 1000\n });\n```\n\nError handling\n--------------\n\nIf a memoized function passes an error to its callback, memoizeAsync will catch\nand rethrow it, so memoizeAsync is transparent in that regard. By default,\nerrors won't be saved in the cache, so the original function will be run\nagain on the next invocation of the memoized function. If you want errors\nto be memoized as well, set the `errors` option to `true`.\n\nInstallation\n------------\n\nMake sure you have node.js and npm installed, then run:\n\n npm install memoizeasync\n\nBrowser compatibility\n---------------------\n\n`memoizeAsync` uses the UMD wrapper, so it should also work in\nbrowsers. You should also have the node-lru-cache\nincluded:\n\n```html\n\n\n\n```\n\n`lru-cache` uses `Object.defineProperty` and doesn't include an UMD\nwrapper, but if you define a `shims` config it should be possible to\nget it memoizeAsync working with require.js, at least in newer browsers.\n\nLicense\n-------\n\n3-clause BSD license -- see the `LICENSE` file for details.\n","_attachments":{},"homepage":"https://github.com/papandreou/node-memoizeasync#readme","bugs":{"url":"https://github.com/papandreou/node-memoizeasync/issues"},"license":"BSD"}