summaryrefslogtreecommitdiffstats
path: root/node_modules/babel-plugin-transform-object-rest-spread/README.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
commite06ec920f7a5d784e674c4c4b4e6d1da3dc7391d (patch)
tree55713f725f77b44ebfec86e4eec3ce33e71458ca /node_modules/babel-plugin-transform-object-rest-spread/README.md
downloadwebsite_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip
api, login, auth
Diffstat (limited to 'node_modules/babel-plugin-transform-object-rest-spread/README.md')
-rw-r--r--node_modules/babel-plugin-transform-object-rest-spread/README.md88
1 files changed, 88 insertions, 0 deletions
diff --git a/node_modules/babel-plugin-transform-object-rest-spread/README.md b/node_modules/babel-plugin-transform-object-rest-spread/README.md
new file mode 100644
index 0000000..79f2432
--- /dev/null
+++ b/node_modules/babel-plugin-transform-object-rest-spread/README.md
@@ -0,0 +1,88 @@
+# babel-plugin-transform-object-rest-spread
+
+> This plugin allows Babel to transform rest properties for object destructuring assignment and spread properties for object literals.
+
+## Example
+
+### Rest Properties
+
+```js
+let { x, y, ...z } = { x: 1, y: 2, a: 3, b: 4 };
+console.log(x); // 1
+console.log(y); // 2
+console.log(z); // { a: 3, b: 4 }
+```
+
+### Spread Properties
+
+```js
+let n = { x, y, ...z };
+console.log(n); // { x: 1, y: 2, a: 3, b: 4 }
+```
+
+## Installation
+
+```sh
+npm install --save-dev babel-plugin-transform-object-rest-spread
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+```json
+{
+ "plugins": ["transform-object-rest-spread"]
+}
+```
+
+### Via CLI
+
+```sh
+babel --plugins transform-object-rest-spread script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+ plugins: ["transform-object-rest-spread"]
+});
+```
+
+## Options
+
+### `useBuiltIns`
+
+`boolean`, defaults to `false`.
+
+By default, this plugin uses Babel's `extends` helper which polyfills `Object.assign`. Enabling this option will use `Object.assign` directly.
+
+**.babelrc**
+
+```json
+{
+ "plugins": [
+ ["transform-object-rest-spread", { "useBuiltIns": true }]
+ ]
+}
+```
+
+**In**
+
+```js
+z = { x, ...y };
+```
+
+**Out**
+
+```js
+z = Object.assign({ x }, y);
+```
+
+## References
+
+* [Proposal: Object Rest/Spread Properties for ECMAScript](https://github.com/sebmarkbage/ecmascript-rest-spread)
+* [Spec](http://sebmarkbage.github.io/ecmascript-rest-spread)