aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@babel/plugin-syntax-async-generators/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/@babel/plugin-syntax-async-generators/README.md')
-rw-r--r--node_modules/@babel/plugin-syntax-async-generators/README.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/node_modules/@babel/plugin-syntax-async-generators/README.md b/node_modules/@babel/plugin-syntax-async-generators/README.md
new file mode 100644
index 00000000..b8f9e7cd
--- /dev/null
+++ b/node_modules/@babel/plugin-syntax-async-generators/README.md
@@ -0,0 +1,57 @@
+# @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": ["@babel/plugin-syntax-async-generators"]
+}
+```
+
+### Via CLI
+
+```sh
+babel --plugins @babel/plugin-syntax-async-generators script.js
+```
+
+### Via Node API
+
+```javascript
+require("@babel/core").transform("code", {
+ plugins: ["@babel/plugin-syntax-async-generators"]
+});
+```
+
+## References
+
+* [Proposal: Asynchronous iteration for ECMAScript](https://github.com/tc39/proposal-async-iteration)