Henry Zhu 2841945095 temporarily rename function-sent pkg to 2 (#6011) [skip ci]
* update readme [skip ci]

* rename to sent2 until we get the package [skip ci]
2017-07-25 17:30:31 -04:00

68 lines
1.2 KiB
Markdown

# babel-plugin-transform-function-sent2
> Publishing as 2 until we get the package
> 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-transform-function-sent
```
## Usage
### Via `.babelrc` (Recommended)
**.babelrc**
```json
{
"plugins": ["transform-function-sent"]
}
```
### Via CLI
```sh
babel --plugins transform-function-sent script.js
```
### Via Node API
```javascript
require("babel-core").transform("code", {
plugins: ["transform-function-sent"]
});
```
## References
* [Proposal](https://github.com/allenwb/ESideas/blob/master/Generator%20metaproperty.md)