summaryrefslogtreecommitdiffstats
path: root/node_modules/babel-plugin-transform-async-to-generator/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/babel-plugin-transform-async-to-generator/README.md')
-rw-r--r--node_modules/babel-plugin-transform-async-to-generator/README.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/node_modules/babel-plugin-transform-async-to-generator/README.md b/node_modules/babel-plugin-transform-async-to-generator/README.md
new file mode 100644
index 0000000..8f50b7a
--- /dev/null
+++ b/node_modules/babel-plugin-transform-async-to-generator/README.md
@@ -0,0 +1,60 @@
+# babel-plugin-transform-async-to-generator
+
+> Turn async functions into ES2015 generators
+
+## Example
+
+**In**
+
+```javascript
+async function foo() {
+ await bar();
+}
+```
+
+**Out**
+
+```javascript
+var _asyncToGenerator = function (fn) {
+ ...
+};
+var foo = _asyncToGenerator(function* () {
+ yield bar();
+});
+```
+
+## Installation
+
+```sh
+npm install --save-dev babel-plugin-transform-async-to-generator
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+```json
+{
+ "plugins": ["transform-async-to-generator"]
+}
+```
+
+### Via CLI
+
+```sh
+babel --plugins transform-async-to-generator script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+ plugins: ["transform-async-to-generator"]
+});
+```
+
+## References
+
+* [Proposal: Async Functions for ECMAScript](https://github.com/tc39/ecmascript-asyncawait)