summaryrefslogtreecommitdiffstats
path: root/node_modules/babel-plugin-transform-regenerator/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/babel-plugin-transform-regenerator/README.md
downloadwebsite_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip
api, login, auth
Diffstat (limited to 'node_modules/babel-plugin-transform-regenerator/README.md')
-rw-r--r--node_modules/babel-plugin-transform-regenerator/README.md87
1 files changed, 87 insertions, 0 deletions
diff --git a/node_modules/babel-plugin-transform-regenerator/README.md b/node_modules/babel-plugin-transform-regenerator/README.md
new file mode 100644
index 0000000..c169863
--- /dev/null
+++ b/node_modules/babel-plugin-transform-regenerator/README.md
@@ -0,0 +1,87 @@
+# babel-plugin-transform-regenerator
+
+> Transform async/generator functions with [regenerator](https://github.com/facebook/regenerator)
+
+## Example
+
+**In**
+
+```javascript
+function* a() {
+ yield 1;
+}
+```
+
+**Out**
+
+```javascript
+var _marked = [a].map(regeneratorRuntime.mark);
+
+function a() {
+ return regeneratorRuntime.wrap(function a$(_context) {
+ while (1) {
+ switch (_context.prev = _context.next) {
+ case 0:
+ _context.next = 2;
+ return 1;
+
+ case 2:
+ case "end":
+ return _context.stop();
+ }
+ }
+ }, _marked[0], this);
+}
+```
+
+## Installation
+
+```sh
+npm install --save-dev babel-plugin-transform-regenerator
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+Without options:
+
+```json
+{
+ "plugins": ["transform-regenerator"]
+}
+```
+
+With options:
+
+|name|default value|
+|---|---|
+|asyncGenerators|true|
+|generators|true|
+|async|true|
+
+```json
+{
+ "plugins": [
+ ["transform-regenerator", {
+ "asyncGenerators": false,
+ "generators": false,
+ "async": false
+ }]
+ ]
+}
+```
+
+### Via CLI
+
+```sh
+babel --plugins transform-regenerator script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+ plugins: ["transform-regenerator"]
+});
+```