Rick Waldron 3a6fdca069 Make all packages/*/README.md descriptions consistent.
Signed-off-by: Rick Waldron <waldron.rick@gmail.com>
2017-05-31 10:24:26 -04:00

58 lines
759 B
Markdown

# babel-plugin-syntax-async-generators
> Allow parsing of async generator functions.
## Example
**Syntax**
```javascript
async function* agf() {
await 1;
}
```
```js
async function f() {
for await (let x of y) {
g(x);
}
}
```
## Installation
```sh
npm install --save-dev babel-plugin-syntax-async-generators
```
## Usage
### Via `.babelrc` (Recommended)
**.babelrc**
```json
{
"plugins": ["syntax-async-generators"]
}
```
### Via CLI
```sh
babel --plugins syntax-async-generators script.js
```
### Via Node API
```javascript
require("babel-core").transform("code", {
plugins: ["syntax-async-generators"]
});
```
## References
* [Proposal: Asynchronous iteration for ECMAScript](https://github.com/tc39/proposal-async-iteration)