diff options
Diffstat (limited to 'node_modules/regjsparser/README.md')
| -rw-r--r-- | node_modules/regjsparser/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/node_modules/regjsparser/README.md b/node_modules/regjsparser/README.md new file mode 100644 index 00000000..8ed945c7 --- /dev/null +++ b/node_modules/regjsparser/README.md @@ -0,0 +1,44 @@ +# RegJSParser + +Parsing the JavaScript's RegExp in JavaScript. + +## Installation + +```bash +npm install regjsparser +``` + +## Usage + +```js +var parse = require('regjsparser').parse; + +var parseTree = parse('^a'); // /^a/ +console.log(parseTree); + +// Toggle on/off additional features: +var parseTree = parse('^a', { + // SEE: https://github.com/jviereck/regjsparser/pull/78 + unicodePropertyEscape: true, + + // SEE: https://github.com/jviereck/regjsparser/pull/83 + namedGroups: true +}); +console.log(parseTree); +``` + +## Testing + +To run the tests, run the following command: + +```bash +npm test +``` + +To create a new reference file, execute… + +```bash +node test/update-fixtures.js +``` + +…from the repo top directory. |
