diff options
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.md | 89 |
1 files changed, 0 insertions, 89 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 deleted file mode 100644 index 8065bc8e..00000000 --- a/node_modules/@babel/plugin-transform-async-to-generator/README.md +++ /dev/null @@ -1,89 +0,0 @@ -# @babel/plugin-transform-async-to-generator - -> Turn async functions into ES2015 generators - -> In Babel 7, `transform-async-to-module-method` was merged into this plugin - -## Example - -**In** - -```javascript -async function foo() { - await bar(); -} -``` - -**Out** - -```javascript -var _asyncToGenerator = function (fn) { - ... -}; -var foo = _asyncToGenerator(function* () { - yield bar(); -}); -``` - -**Out with options** - -> Turn async functions into a Bluebird coroutine - -```javascript -var Bluebird = require("bluebird"); - -var foo = Bluebird.coroutine(function* () { - yield bar(); -}); -``` - -## Installation - -```sh -npm install --save-dev @babel/plugin-transform-async-to-generator -``` - -## Usage - -### Via `.babelrc` (Recommended) - -**.babelrc** - -Without options: - -```json -{ - "plugins": ["@babel/plugin-transform-async-to-generator"] -} -``` - -With options: - -```json -{ - "plugins": [ - ["@babel/plugin-transform-async-to-generator", { - "module": "bluebird", - "method": "coroutine" - }] - ] -} -``` - -### Via CLI - -```sh -babel --plugins @babel/plugin-transform-async-to-generator script.js -``` - -### Via Node API - -```javascript -require("@babel/core").transform("code", { - plugins: ["@babel/plugin-transform-async-to-generator"] -}); -``` - -## References - -* [Proposal: Async Functions for ECMAScript](https://github.com/tc39/ecmascript-asyncawait) |
