summaryrefslogtreecommitdiffstats
path: root/node_modules/regenerator-transform/README.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
commite06ec920f7a5d784e674c4c4b4e6d1da3dc7391d (patch)
tree55713f725f77b44ebfec86e4eec3ce33e71458ca /node_modules/regenerator-transform/README.md
downloadwebsite_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip
api, login, auth
Diffstat (limited to 'node_modules/regenerator-transform/README.md')
-rw-r--r--node_modules/regenerator-transform/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/node_modules/regenerator-transform/README.md b/node_modules/regenerator-transform/README.md
new file mode 100644
index 0000000..1b09792
--- /dev/null
+++ b/node_modules/regenerator-transform/README.md
@@ -0,0 +1,46 @@
+# regenerator-transform
+
+Transform async/generator functions with [regenerator](https://github.com/facebook/regenerator)
+
+## Installation
+
+```sh
+$ npm install regenerator-transform
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+```js
+// without options
+{
+ "plugins": ["regenerator-transform"]
+}
+// with options
+{
+ "plugins": [
+ ["regenerator-transform", {
+ asyncGenerators: false, // true by default
+ generators: false, // true by default
+ async: false // true by default
+ }]
+ ]
+}
+```
+
+### Via CLI
+
+```sh
+$ babel --plugins regenerator-transform script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+ plugins: ["regenerator-transform"]
+});
+```