aboutsummaryrefslogtreecommitdiff
path: root/node_modules/regjsgen/README.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/regjsgen/README.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/regjsgen/README.md')
-rw-r--r--node_modules/regjsgen/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/node_modules/regjsgen/README.md b/node_modules/regjsgen/README.md
new file mode 100644
index 00000000..74dc3e99
--- /dev/null
+++ b/node_modules/regjsgen/README.md
@@ -0,0 +1,33 @@
+# regjsgen [![Build status](https://travis-ci.org/bnjmnt4n/regjsgen.svg?branch=master)](https://travis-ci.org/bnjmnt4n/regjsgen) [![Code coverage status](https://codecov.io/gh/bnjmnt4n/regjsgen/branch/master/graph/badge.svg)](https://codecov.io/gh/bnjmnt4n/regjsgen)
+
+Generate regular expressions from [regjsparser](https://github.com/jviereck/regjsparser)’s AST.
+
+## Installation
+
+```bash
+npm install --save regjsgen
+```
+
+## API
+
+### `regjsgen.generate(ast)`
+
+This function accepts an abstract syntax tree representing a regular expression, and returns the generated regular expression string.
+
+```js
+var regjsparser = require('regjsparser');
+var regjsgen = require('regjsgen');
+
+// Generate an AST with `regjsparser`.
+var ast = regjsparser.parse(regex);
+
+// Modify AST
+// …
+
+// Generate `RegExp` string with `regjsgen`.
+regex = regjsgen.generate(ast);
+```
+
+## Support
+
+Tested in Node.js 0.10, 0.12, 4, 6 and 8.