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:
@@ -2,103 +2,18 @@
|
||||
|
||||
> Compile ES2015 destructuring to ES5
|
||||
|
||||
## Examples
|
||||
See our website [@babel/plugin-transform-destructuring](https://new.babeljs.io/docs/en/next/babel-plugin-transform-destructuring.html) for more information.
|
||||
|
||||
**In**
|
||||
## Install
|
||||
|
||||
```javascript
|
||||
let {x, y} = obj;
|
||||
|
||||
let [a, b, ...rest] = arr;
|
||||
```
|
||||
|
||||
**Out**
|
||||
|
||||
```javascript
|
||||
function _toArray(arr) { ... }
|
||||
|
||||
let _obj = obj,
|
||||
x = _obj.x,
|
||||
y = _obj.y;
|
||||
|
||||
let _arr = arr,
|
||||
_arr2 = _toArray(_arr),
|
||||
a = _arr2[0],
|
||||
b = _arr2[1],
|
||||
rest = _arr2.slice(2);
|
||||
```
|
||||
|
||||
## Installation
|
||||
Using npm:
|
||||
|
||||
```sh
|
||||
npm install --save-dev @babel/plugin-transform-destructuring
|
||||
npm install --save @babel/plugin-transform-destructuring
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Via `.babelrc` (Recommended)
|
||||
|
||||
**.babelrc**
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": ["@babel/plugin-transform-destructuring"]
|
||||
}
|
||||
```
|
||||
|
||||
### Via CLI
|
||||
or using yarn:
|
||||
|
||||
```sh
|
||||
babel --plugins @babel/plugin-transform-destructuring script.js
|
||||
yarn add --save @babel/plugin-transform-destructuring
|
||||
```
|
||||
|
||||
### Via Node API
|
||||
|
||||
```javascript
|
||||
require("@babel/core").transform("code", {
|
||||
plugins: ["@babel/plugin-transform-destructuring"]
|
||||
});
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
### `loose`
|
||||
|
||||
`boolean`, defaults to `false`.
|
||||
|
||||
Enabling this option will assume that what you want to destructure is an array and won't use `Array.from` on other iterables.
|
||||
|
||||
### `useBuiltIns`
|
||||
|
||||
`boolean`, defaults to `false`.
|
||||
|
||||
Enabling this option will use `Object.assign` directly instead of the Babel's `extends` helper.
|
||||
|
||||
##### Example
|
||||
|
||||
**.babelrc**
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": [
|
||||
["@babel/plugin-transform-destructuring", { "useBuiltIns": true }]
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**In**
|
||||
|
||||
```js
|
||||
var { ...x } = z;
|
||||
```
|
||||
|
||||
**Out**
|
||||
|
||||
```js
|
||||
var _z = z,
|
||||
x = Object.assign({}, _z);
|
||||
```
|
||||
|
||||
## References
|
||||
|
||||
* [MDN: Destructuring assignment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment)
|
||||
|
||||
Reference in New Issue
Block a user