@babel/plugin-transform-parameters

NOTE: This plugin is included in @babel/preset-env

This plugin transforms ES2015 parameters to ES5, this includes:

  • Destructuring parameters
  • Default parameters
  • Rest parameters

Examples

In

  1. function test(x = "hello", { a, b }, ...args) {
  2.   console.log(x, a, b, args);
  3. }

Out

  1. function test() {
  2.   var x =
  3.     arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "hello";
  4.   var _ref = arguments[1];
  5.   var a = _ref.a,
  6.     b = _ref.b;
  8.   for (
  9.     var _len = arguments.length,
  10.       args = Array(_len > 2 ? _len - 2 : 0),
  11.       _key = 2;
  12.     _key < _len;
  13.     _key++
  14.   ) {
  15.     args[_key - 2] = arguments[_key];
  16.   }
  18.   console.log(x, a, b, args);
  19. }

Installation

  1. npm install --save-dev @babel/plugin-transform-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 @babel/plugin-transform-block-scoping plugin.

Usage

With a configuration file (Recommended)

  1. {
  2.   "plugins": ["@babel/plugin-transform-parameters"]
  3. }

Via CLI

  1. babel --plugins @babel/plugin-transform-parameters script.js

Via Node API

  1. require("@babel/core").transformSync("code", {
  2.   plugins: ["@babel/plugin-transform-parameters"],
  3. });

Options

loose

boolean, defaults to false.

In loose mode, parameters with default values will be counted into the arity of the function. This is not spec behavior where these parameters do not add to function arity.

⚠️ Consider migrating to the top level ignoreFunctionLength assumption.

  1. // babel.config.json
  2. {
  3.   "assumptions": {
  4.     "ignoreFunctionLength": true
  5.   }
  6. }

Under the ignoreFunctionLength assumption, Babel will generate a more performant solution as JavaScript engines will fully optimize a function that doesn’t reference arguments. Please do your own benchmarking and determine if this option is the right fit for your application.

  1. // Spec behavior
  2. function bar1(arg1 = 1) {}
  3. bar1.length; // 0
  5. // ignoreFunctionLength: true
  6. function bar1(arg1 = 1) {}
  7. bar1.length; // 1

You can read more about configuring plugin options here