aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@babel/plugin-transform-destructuring/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/@babel/plugin-transform-destructuring/README.md')
-rw-r--r--node_modules/@babel/plugin-transform-destructuring/README.md104
1 files changed, 104 insertions, 0 deletions
diff --git a/node_modules/@babel/plugin-transform-destructuring/README.md b/node_modules/@babel/plugin-transform-destructuring/README.md
new file mode 100644
index 00000000..d31e0e20
--- /dev/null
+++ b/node_modules/@babel/plugin-transform-destructuring/README.md
@@ -0,0 +1,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)