diff options
Diffstat (limited to 'node_modules/@babel/plugin-proposal-function-sent/README.md')
| -rw-r--r-- | node_modules/@babel/plugin-proposal-function-sent/README.md | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/node_modules/@babel/plugin-proposal-function-sent/README.md b/node_modules/@babel/plugin-proposal-function-sent/README.md new file mode 100644 index 00000000..9c498491 --- /dev/null +++ b/node_modules/@babel/plugin-proposal-function-sent/README.md @@ -0,0 +1,66 @@ +# @babel/plugin-proposal-function-sent + +> Compile the `function.sent` meta property, used inside generator functions, to valid ES2015 code. + +## Example + +```js +function* generator() { + console.log("Sent", function.sent); + console.log("Yield", yield); +} + +const iterator = generator(); +iterator.next(1); // Logs "Sent 1" +iterator.next(2); // Logs "Yield 2" +``` + +Is compiled roughly to + +```js +let generator = _skipFirstGeneratorNext(function* () { + const _functionSent = yield; + console.log("Sent", _functionSent); + console.log("Yield", yield); +}); + +const iterator = generator(); +iterator.next(1); // Logs "Sent 1" +iterator.next(2); // Logs "Yield 1" +``` + +## Installation + +```sh +npm install --save-dev @babel/plugin-proposal-function-sent +``` + +## Usage + +### Via `.babelrc` (Recommended) + +**.babelrc** + +```json +{ + "plugins": ["@babel/plugin-proposal-function-sent"] +} +``` + +### Via CLI + +```sh +babel --plugins @babel/plugin-proposal-function-sent script.js +``` + +### Via Node API + +```javascript +require("@babel/core").transform("code", { + plugins: ["@babel/plugin-proposal-function-sent"] +}); +``` + +## References + +* [Proposal](https://github.com/allenwb/ESideas/blob/master/Generator%20metaproperty.md) |
