aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@babel/plugin-transform-destructuring/README.md
blob: d31e0e206ec4a398ea021da0dc4a1e226d6a25da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# @babel/plugin-transform-destructuring

> Compile ES2015 destructuring to ES5

## Examples

**In**

```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

```sh
npm install --save-dev @babel/plugin-transform-destructuring
```

## Usage

### Via `.babelrc` (Recommended)

**.babelrc**

```json
{
  "plugins": ["@babel/plugin-transform-destructuring"]
}
```

### Via CLI

```sh
babel --plugins @babel/plugin-transform-destructuring script.js
```

### 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)