{ "_args": [ [ { "raw": "regex-cache@^0.4.2", "scope": null, "escapedName": "regex-cache", "name": "regex-cache", "rawSpec": "^0.4.2", "spec": ">=0.4.2 <0.5.0", "type": "range" }, "/home/jdaugherty/work/GT2/GT2-Android/node_modules/micromatch" ] ], "_from": "regex-cache@>=0.4.2 <0.5.0", "_id": "regex-cache@0.4.4", "_inCache": true, "_location": "/regex-cache", "_nodeVersion": "8.4.0", "_npmOperationalInternal": { "host": "s3://npm-registry-packages", "tmp": "tmp/regex-cache-0.4.4.tgz_1504279132002_0.2753396413754672" }, "_npmUser": { "name": "doowb", "email": "brian.woodward@gmail.com" }, "_npmVersion": "5.3.0", "_phantomChildren": {}, "_requested": { "raw": "regex-cache@^0.4.2", "scope": null, "escapedName": "regex-cache", "name": "regex-cache", "rawSpec": "^0.4.2", "spec": ">=0.4.2 <0.5.0", "type": "range" }, "_requiredBy": [ "/micromatch" ], "_resolved": "https://registry.npmjs.org/regex-cache/-/regex-cache-0.4.4.tgz", "_shasum": "75bdc58a2a1496cec48a12835bc54c8d562336dd", "_shrinkwrap": null, "_spec": "regex-cache@^0.4.2", "_where": "/home/jdaugherty/work/GT2/GT2-Android/node_modules/micromatch", "author": { "name": "Jon Schlinkert", "url": "https://github.com/jonschlinkert" }, "bugs": { "url": "https://github.com/jonschlinkert/regex-cache/issues" }, "contributors": [ { "name": "Jon Schlinkert", "url": "http://twitter.com/jonschlinkert" }, { "name": "Martin Kolárik", "url": "https://kolarik.sk" } ], "dependencies": { "is-equal-shallow": "^0.1.3" }, "description": "Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in surprising performance improvements.", "devDependencies": { "ansi-bold": "^0.1.1", "benchmarked": "^0.1.5", "gulp-format-md": "^0.1.7", "micromatch": "^2.3.7", "should": "^8.3.0" }, "directories": {}, "dist": { "integrity": "sha512-nVIZwtCjkC9YgvWkpM55B5rBhBYRZhAaJbgcFYXXsHnbZ9UZI9nnVWYZpBlCqv9ho2eZryPnWrZGsOdPwVWXWQ==", "shasum": "75bdc58a2a1496cec48a12835bc54c8d562336dd", "tarball": "https://registry.npmjs.org/regex-cache/-/regex-cache-0.4.4.tgz" }, "engines": { "node": ">=0.10.0" }, "files": [ "index.js" ], "gitHead": "e5ced08e45d2cc2d286a9e7b5a574963f6577712", "homepage": "https://github.com/jonschlinkert/regex-cache", "keywords": [ "cache", "expression", "regex", "regexp", "regular", "regular expression", "store", "to-regex" ], "license": "MIT", "main": "index.js", "maintainers": [ { "name": "jonschlinkert", "email": "github@sellside.com" }, { "name": "doowb", "email": "brian.woodward@gmail.com" } ], "name": "regex-cache", "optionalDependencies": {}, "readme": "# regex-cache [![NPM version](https://img.shields.io/npm/v/regex-cache.svg?style=flat)](https://www.npmjs.com/package/regex-cache) [![NPM monthly downloads](https://img.shields.io/npm/dm/regex-cache.svg?style=flat)](https://npmjs.org/package/regex-cache) [![NPM total downloads](https://img.shields.io/npm/dt/regex-cache.svg?style=flat)](https://npmjs.org/package/regex-cache) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/regex-cache.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/regex-cache) [![Windows Build Status](https://img.shields.io/appveyor/ci/jonschlinkert/regex-cache.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/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 surprising performance improvements.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save regex-cache\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\n## About\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- | \n| 31 | [jonschlinkert](https://github.com/jonschlinkert) | \n| 1 | [MartinKolarik](https://github.com/MartinKolarik) | \n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 01, 2017._", "readmeFilename": "README.md", "repository": { "type": "git", "url": "git+https://github.com/jonschlinkert/regex-cache.git" }, "scripts": { "benchmarks": "node benchmark", "test": "mocha" }, "verb": { "run": true, "toc": false, "layout": "default", "tasks": [ "readme" ], "plugins": [ "gulp-format-md" ], "reflinks": [ "verb" ], "lint": { "reflinks": true } }, "version": "0.4.4" }