1 line
18 KiB
JSON
1 line
18 KiB
JSON
{"_id":"regex-cache","_rev":"14-97577cab4f0e1d138fb0ba74007c5675","name":"regex-cache","description":"Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in suprising performance improvements.","dist-tags":{"latest":"0.4.3"},"versions":{"0.1.0":{"name":"regex-cache","description":"Memoize the results of a call to the RegExp constructor. Whenever possible, avoiding repetitious runtime compilation of the same string and options can result in dramatic speed improvements.","version":"0.1.0","homepage":"https://github.com/jonschlinkert/regex-cache","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/regex-cache.git"},"bugs":{"url":"https://github.com/jonschlinkert/regex-cache/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/regex-cache/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha","benchmarks":"node benchmark"},"dependencies":{"benchmarked":"^0.1.3","chalk":"^0.5.1","micromatch":"^1.2.2"},"devDependencies":{"mentions-regex":"^1.0.1","mocha":"^2.1.0","should":"*"},"keywords":[],"gitHead":"fb650dd8badcb3e55ad89042b6d48c45f4437aed","_id":"regex-cache@0.1.0","_shasum":"5562267f3e12903e5c464e70f06a38d27c2a8184","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"5562267f3e12903e5c464e70f06a38d27c2a8184","tarball":"https://registry.npmjs.org/regex-cache/-/regex-cache-0.1.0.tgz"},"directories":{}},"0.1.1":{"name":"regex-cache","description":"Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in dramatic speed improvements.","version":"0.1.1","homepage":"https://github.com/jonschlinkert/regex-cache","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/regex-cache.git"},"bugs":{"url":"https://github.com/jonschlinkert/regex-cache/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/regex-cache/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha","benchmarks":"node benchmark"},"dependencies":{"benchmarked":"^0.1.3","chalk":"^0.5.1","micromatch":"^1.2.2"},"devDependencies":{"mentions-regex":"^1.0.1","mocha":"^2.1.0","should":"*"},"keywords":[],"gitHead":"fb650dd8badcb3e55ad89042b6d48c45f4437aed","_id":"regex-cache@0.1.1","_shasum":"c770cf43cf31edf80656ed5139d2786ba876470d","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"c770cf43cf31edf80656ed5139d2786ba876470d","tarball":"https://registry.npmjs.org/regex-cache/-/regex-cache-0.1.1.tgz"},"directories":{}},"0.2.0":{"name":"regex-cache","description":"Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in dramatic speed improvements.","version":"0.2.0","homepage":"https://github.com/jonschlinkert/regex-cache","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/regex-cache.git"},"bugs":{"url":"https://github.com/jonschlinkert/regex-cache/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/regex-cache/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha","benchmarks":"node benchmark"},"dependencies":{"benchmarked":"^0.1.3","chalk":"^0.5.1","micromatch":"^1.2.2"},"devDependencies":{"mentions-regex":"^1.0.1","mocha":"^2.1.0","should":"*"},"keywords":[],"gitHead":"2fcb3ee060ca41acb8bd1496c3115f99a51ee0a4","_id":"regex-cache@0.2.0","_shasum":"3bed13fad0cf9bb9768d1c64694f592467bf4c16","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"3bed13fad0cf9bb9768d1c64694f592467bf4c16","tarball":"https://registry.npmjs.org/regex-cache/-/regex-cache-0.2.0.tgz"},"directories":{}},"0.2.1":{"name":"regex-cache","description":"Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in dramatic speed improvements.","version":"0.2.1","homepage":"https://github.com/jonschlinkert/regex-cache","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/regex-cache.git"},"bugs":{"url":"https://github.com/jonschlinkert/regex-cache/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/regex-cache/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha","benchmarks":"node benchmark"},"dependencies":{"benchmarked":"^0.1.3","chalk":"^0.5.1","micromatch":"^1.2.2"},"devDependencies":{"mentions-regex":"^1.0.1","mocha":"^2.1.0","should":"*"},"keywords":[],"gitHead":"32d89bc73bc8b293603e7c9701c8437e0204808d","_id":"regex-cache@0.2.1","_shasum":"035ae2117c2d9bb78d8154939edac6914afee9ad","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"035ae2117c2d9bb78d8154939edac6914afee9ad","tarball":"https://registry.npmjs.org/regex-cache/-/regex-cache-0.2.1.tgz"},"directories":{}},"0.3.0":{"name":"regex-cache","description":"Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in dramatic speed improvements.","version":"0.3.0","homepage":"https://github.com/jonschlinkert/regex-cache","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/regex-cache.git"},"bugs":{"url":"https://github.com/jonschlinkert/regex-cache/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/regex-cache/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha","benchmarks":"node benchmark"},"dependencies":{"benchmarked":"^0.1.3","chalk":"^0.5.1","micromatch":"^1.2.2","to-key":"^1.0.0"},"devDependencies":{"mocha":"^2.1.0","should":"*"},"keywords":["cache","expression","regex","regexp","regular","regular expression","store","to-regex"],"gitHead":"2bd4995be9229e1d6d0acbcfebab2ea069b73d3d","_id":"regex-cache@0.3.0","_shasum":"3ea036627179102bfb1a2364ab2679a0f32964c0","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"3ea036627179102bfb1a2364ab2679a0f32964c0","tarball":"https://registry.npmjs.org/regex-cache/-/regex-cache-0.3.0.tgz"},"directories":{}},"0.4.1":{"name":"regex-cache","description":"Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in dramatic speed improvements.","version":"0.4.1","homepage":"https://github.com/jonschlinkert/regex-cache","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/regex-cache.git"},"bugs":{"url":"https://github.com/jonschlinkert/regex-cache/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/regex-cache/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha","benchmarks":"node benchmark"},"dependencies":{"is-equal-shallow":"^0.1.1","is-primitive":"^2.0.0"},"devDependencies":{"benchmarked":"^0.1.4","chalk":"^1.0.0","micromatch":"^2.1.0","mocha":"^2.1.0","should":"*"},"keywords":["cache","expression","regex","regexp","regular","regular expression","store","to-regex"],"gitHead":"9478eec6d9322a96a6ceb3e5488cd8433295a95f","_id":"regex-cache@0.4.1","_shasum":"709c5cec5ae8ec312c5992a84b6ec966a3fe94a0","_from":".","_npmVersion":"2.7.1","_nodeVersion":"1.6.2","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"709c5cec5ae8ec312c5992a84b6ec966a3fe94a0","tarball":"https://registry.npmjs.org/regex-cache/-/regex-cache-0.4.1.tgz"},"directories":{}},"0.4.2":{"name":"regex-cache","description":"Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in dramatic speed improvements.","version":"0.4.2","homepage":"https://github.com/jonschlinkert/regex-cache","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/regex-cache.git"},"bugs":{"url":"https://github.com/jonschlinkert/regex-cache/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/regex-cache/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha","benchmarks":"node benchmark"},"dependencies":{"is-equal-shallow":"^0.1.1","is-primitive":"^2.0.0"},"devDependencies":{"benchmarked":"^0.1.4","chalk":"^1.0.0","micromatch":"^2.1.0","mocha":"^2.1.0","should":"*"},"keywords":["cache","expression","regex","regexp","regular","regular expression","store","to-regex"],"gitHead":"9478eec6d9322a96a6ceb3e5488cd8433295a95f","_id":"regex-cache@0.4.2","_shasum":"6e4f89c266bc03c33fd129c062184687f4663487","_from":".","_npmVersion":"2.7.1","_nodeVersion":"1.6.2","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"6e4f89c266bc03c33fd129c062184687f4663487","tarball":"https://registry.npmjs.org/regex-cache/-/regex-cache-0.4.2.tgz"},"directories":{}},"0.4.3":{"name":"regex-cache","description":"Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in suprising performance improvements.","version":"0.4.3","homepage":"https://github.com/jonschlinkert/regex-cache","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/regex-cache.git"},"bugs":{"url":"https://github.com/jonschlinkert/regex-cache/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha","benchmarks":"node benchmark"},"dependencies":{"is-equal-shallow":"^0.1.3","is-primitive":"^2.0.0"},"devDependencies":{"benchmarked":"^0.1.5","chalk":"^1.1.3","gulp-format-md":"^0.1.7","micromatch":"^2.3.7","should":"^8.3.0"},"keywords":["cache","expression","regex","regexp","regular","regular expression","store","to-regex"],"verb":{"run":true,"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"reflinks":["verb"],"lint":{"reflinks":true}},"gitHead":"06ce46bda29a19064a968bd5d2d5596440be05ca","_id":"regex-cache@0.4.3","_shasum":"9b1a6c35d4d0dfcef5711ae651e8e9d3d7114145","_from":".","_npmVersion":"3.6.0","_nodeVersion":"5.5.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"},{"name":"doowb","email":"brian.woodward@gmail.com"}],"dist":{"shasum":"9b1a6c35d4d0dfcef5711ae651e8e9d3d7114145","tarball":"https://registry.npmjs.org/regex-cache/-/regex-cache-0.4.3.tgz"},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/regex-cache-0.4.3.tgz_1459536604904_0.22530420310795307"},"directories":{}}},"readme":"# regex-cache [](https://www.npmjs.com/package/regex-cache) [](https://npmjs.org/package/regex-cache) [](https://travis-ci.org/jonschlinkert/regex-cache)\n\n> Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in suprising performance improvements.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install regex-cache --save\n```\n\n* Read [what this does](#what-this-does).\n* See [the benchmarks](#benchmarks)\n\n## Usage\n\nWrap a function like this:\n\n```js\nvar cache = require('regex-cache');\nvar someRegex = cache(require('some-regex-lib'));\n```\n\n**Caching a regex**\n\nIf you want to cache a regex after calling `new RegExp()`, or you're requiring a module that returns a regex, wrap it with a function first:\n\n```js\nvar cache = require('regex-cache');\n\nfunction yourRegex(str, opts) {\n // do stuff to str and opts\n return new RegExp(str, opts.flags);\n}\n\nvar regex = cache(yourRegex);\n```\n\n## Recommendations\n\n### Use this when...\n\n* **No options are passed** to the function that creates the regex. Regardless of how big or small the regex is, when zero options are passed, caching will be faster than not.\n* **A few options are passed**, and the values are primitives. The limited benchmarks I did show that caching is beneficial when up to 8 or 9 options are passed.\n\n### Do not use this when...\n\n* **The values of options are not primitives**. When non-primitives must be compared for equality, the time to compare the options is most likely as long or longer than the time to just create a new regex.\n\n### Example benchmarks\n\nPerformance results, with and without regex-cache:\n\n```bash\n# no args passed (defaults)\n with-cache x 8,699,231 ops/sec ±0.86% (93 runs sampled)\n without-cache x 2,777,551 ops/sec ±0.63% (95 runs sampled)\n\n# string and six options passed\n with-cache x 1,885,934 ops/sec ±0.80% (93 runs sampled)\n without-cache x 1,256,893 ops/sec ±0.65% (97 runs sampled)\n\n# string only\n with-cache x 7,723,256 ops/sec ±0.87% (92 runs sampled)\n without-cache x 2,303,060 ops/sec ±0.47% (99 runs sampled)\n\n# one option passed\n with-cache x 4,179,877 ops/sec ±0.53% (100 runs sampled)\n without-cache x 2,198,422 ops/sec ±0.47% (95 runs sampled)\n\n# two options passed\n with-cache x 3,256,222 ops/sec ±0.51% (99 runs sampled)\n without-cache x 2,121,401 ops/sec ±0.79% (97 runs sampled)\n\n# six options passed\n with-cache x 1,816,018 ops/sec ±1.08% (96 runs sampled)\n without-cache x 1,157,176 ops/sec ±0.53% (100 runs sampled)\n\n# \n# diminishing returns happen about here\n# \n\n# ten options passed\n with-cache x 1,210,598 ops/sec ±0.56% (92 runs sampled)\n without-cache x 1,665,588 ops/sec ±1.07% (100 runs sampled)\n\n# twelve options passed\n with-cache x 1,042,096 ops/sec ±0.68% (92 runs sampled)\n without-cache x 1,389,414 ops/sec ±0.68% (97 runs sampled)\n\n# twenty options passed\n with-cache x 661,125 ops/sec ±0.80% (93 runs sampled)\n without-cache x 1,208,757 ops/sec ±0.65% (97 runs sampled)\n\n# \n# when non-primitive values are compared\n# \n\n# single value on the options is an object\n with-cache x 1,398,313 ops/sec ±1.05% (95 runs sampled)\n without-cache x 2,228,281 ops/sec ±0.56% (99 runs sampled)\n```\n\n## Run benchmarks\n\nInstall dev dependencies:\n\n```bash\nnpm i -d && npm run benchmarks\n```\n\n## What this does\n\nIf you're using `new RegExp('foo')` instead of a regex literal, it's probably because you need to dyamically generate a regex based on user options or some other potentially changing factors.\n\nWhen your function creates a string based on user inputs and passes it to the `RegExp` constructor, regex-cache caches the results. The next time the function is called if the key of a cached regex matches the user input (or no input was given), the cached regex is returned, avoiding unnecessary runtime compilation.\n\nUsing the RegExp constructor offers a lot of flexibility, but the runtime compilation comes at a price - it's slow. Not specifically because of the call to the RegExp constructor, but **because you have to build up the string before `new RegExp()` is even called**.\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/regex-cache/issues/new).\n\n## Building docs\n\nGenerate readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install verb && npm run docs\n```\n\nOr, if [verb](https://github.com/verbose/verb) is installed globally:\n\n```sh\n$ verb\n```\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n## Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/regex-cache/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb](https://github.com/verbose/verb), v, on April 01, 2016._","maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"},{"name":"doowb","email":"brian.woodward@gmail.com"}],"time":{"modified":"2016-04-01T18:50:07.156Z","created":"2015-02-09T12:14:22.194Z","0.1.0":"2015-02-09T12:14:22.194Z","0.1.1":"2015-02-09T12:16:02.663Z","0.2.0":"2015-02-09T13:37:14.168Z","0.2.1":"2015-02-17T01:25:54.933Z","0.3.0":"2015-02-17T08:04:50.627Z","0.4.1":"2015-03-25T22:26:57.199Z","0.4.2":"2015-03-25T22:28:18.072Z","0.4.3":"2016-04-01T18:50:07.156Z"},"homepage":"https://github.com/jonschlinkert/regex-cache","keywords":["cache","expression","regex","regexp","regular","regular expression","store","to-regex"],"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/regex-cache.git"},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"bugs":{"url":"https://github.com/jonschlinkert/regex-cache/issues"},"license":"MIT","readmeFilename":"README.md","_attachments":{},"_etag":"W/\"56fec2df-4889\"","_lastModified":"Fri, 01 Apr 2016 18:50:07 GMT","_cached":true} |