Refactor move docs (#8108)
* feat: [skip] generate readme script * docs: [skip ci] update READMEs * docs: [skip ci] fix code block type * chore: [skip ci] move generator script
This commit is contained in:
@@ -1,121 +1,19 @@
|
||||
# @babel/plugin-proposal-function-bind
|
||||
|
||||
> Compile the new function bind operator `::` to ES5.
|
||||
> Compile function bind operator to ES5
|
||||
|
||||
## Detail
|
||||
See our website [@babel/plugin-proposal-function-bind](https://new.babeljs.io/docs/en/next/babel-plugin-proposal-function-bind.html) for more information.
|
||||
|
||||
```js
|
||||
obj::func
|
||||
// is equivalent to:
|
||||
func.bind(obj)
|
||||
## Install
|
||||
|
||||
::obj.func
|
||||
// is equivalent to:
|
||||
obj.func.bind(obj)
|
||||
|
||||
obj::func(val)
|
||||
// is equivalent to:
|
||||
func.call(obj, val)
|
||||
|
||||
::obj.func(val)
|
||||
// is equivalent to:
|
||||
obj.func.call(obj, val)
|
||||
```
|
||||
|
||||
|
||||
## Example
|
||||
|
||||
### Basic
|
||||
|
||||
```js
|
||||
const box = {
|
||||
weight: 2,
|
||||
getWeight() { return this.weight; },
|
||||
};
|
||||
|
||||
const { getWeight } = box;
|
||||
|
||||
console.log(box.getWeight()); // prints '2'
|
||||
|
||||
const bigBox = { weight: 10 };
|
||||
console.log(bigBox::getWeight()); // prints '10'
|
||||
|
||||
// Can be chained:
|
||||
function add(val) { return this + val; }
|
||||
|
||||
console.log(bigBox::getWeight()::add(5)); // prints '15'
|
||||
```
|
||||
|
||||
|
||||
### Using with `document.querySelectorAll`
|
||||
|
||||
It can be very handy when used with `document.querySelectorAll`:
|
||||
|
||||
```js
|
||||
const { map, filter } = Array.prototype;
|
||||
|
||||
let sslUrls = document.querySelectorAll('a')
|
||||
::map(node => node.href)
|
||||
::filter(href => href.substring(0, 5) === 'https');
|
||||
|
||||
console.log(sslUrls);
|
||||
```
|
||||
|
||||
|
||||
`document.querySelectorAll` returns a `NodeList` element which is not a plain array, so you normally can't use the `map` function on it, and have to use it this way: `Array.prototype.map.call(document.querySelectorAll(...), node => { ... })`. The above code using the `::` will work because it is equivalent to:
|
||||
|
||||
```js
|
||||
const { map, filter } = Array.prototype;
|
||||
|
||||
let sslUrls = document.querySelectorAll('a');
|
||||
sslUrls = map.call(sslUrls, node => node.href);
|
||||
sslUrls = filter.call(sslUrls, href => href.substring(0, 5) === 'https');
|
||||
|
||||
console.log(sslUrls);
|
||||
```
|
||||
|
||||
### Auto self binding
|
||||
When nothing is specified before the `::` operator, the function is bound to its object:
|
||||
|
||||
```js
|
||||
$('.some-link').on('click', ::view.reset);
|
||||
// is equivalent to:
|
||||
$('.some-link').on('click', view.reset.bind(view));
|
||||
```
|
||||
|
||||
## Installation
|
||||
Using npm:
|
||||
|
||||
```sh
|
||||
npm install --save-dev @babel/plugin-proposal-function-bind
|
||||
npm install --save @babel/plugin-proposal-function-bind
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Via `.babelrc` (Recommended)
|
||||
|
||||
**.babelrc**
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": ["@babel/plugin-proposal-function-bind"]
|
||||
}
|
||||
```
|
||||
|
||||
### Via CLI
|
||||
or using yarn:
|
||||
|
||||
```sh
|
||||
babel --plugins @babel/plugin-proposal-function-bind script.js
|
||||
yarn add --save @babel/plugin-proposal-function-bind
|
||||
```
|
||||
|
||||
### Via Node API
|
||||
|
||||
```javascript
|
||||
require("@babel/core").transform("code", {
|
||||
plugins: ["@babel/plugin-proposal-function-bind"]
|
||||
});
|
||||
```
|
||||
|
||||
## References
|
||||
|
||||
* [Proposal](https://github.com/zenparsing/es-function-bind)
|
||||
* [Babel Blog: Function Bind Syntax](/blog/2015/05/14/function-bind)
|
||||
|
||||
Reference in New Issue
Block a user