summaryrefslogtreecommitdiffstats
path: root/node_modules/babel-plugin-transform-es2015-parameters/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/babel-plugin-transform-es2015-parameters/README.md')
-rw-r--r--node_modules/babel-plugin-transform-es2015-parameters/README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/node_modules/babel-plugin-transform-es2015-parameters/README.md b/node_modules/babel-plugin-transform-es2015-parameters/README.md
new file mode 100644
index 0000000..5c52e0c
--- /dev/null
+++ b/node_modules/babel-plugin-transform-es2015-parameters/README.md
@@ -0,0 +1,47 @@
+# babel-plugin-transform-es2015-parameters
+
+> Compile ES2015 default and rest parameters to ES5
+
+This plugin transforms ES2015 parameters to ES5, this includes:
+
+- Destructuring parameters
+- Default parameters
+- Rest parameters
+
+## Installation
+
+```sh
+npm install --save-dev babel-plugin-transform-es2015-parameters
+```
+
+## Caveats
+
+Default parameters desugar into `let` declarations to retain proper semantics. If this is
+not supported in your environment then you'll need the
+[transform-block-scoping](http://babeljs.io/docs/plugins/transform-es2015-block-scoping) plugin.
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+```json
+{
+ "plugins": ["transform-es2015-parameters"]
+}
+```
+
+### Via CLI
+
+```sh
+babel --plugins transform-es2015-parameters script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+ plugins: ["transform-es2015-parameters"]
+});
+```