babel-plugin-transform-object-rest-spread

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

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

let n = { x, y, ...z };
console.log(n); // { x: 1, y: 2, a: 3, b: 4 }

Installation

npm install --save-dev babel-plugin-transform-object-rest-spread

Usage

Via .babelrc (Recommended)

.babelrc

{
  "plugins": ["transform-object-rest-spread"]
}

Via CLI

babel --plugins transform-object-rest-spread script.js

Via Node API

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

{
  "plugins": [
    ["transform-object-rest-spread", { "useBuiltIns": true }]
  ]
}

In

z = { x, ...y };

Out

z = Object.assign({ x }, y);

References

• Proposal: Object Rest/Spread Properties for ECMAScript
• Spec

Similar packages

Other packages similar to babel-plugin-transform-object-rest-spread

@babel/plugin-proposal-object-rest-spread

This is the official Babel plugin for transforming object rest and spread syntax. It is similar to babel-plugin-transform-object-rest-spread but is maintained as part of the Babel 7 release. It is the recommended package to use for Babel 7 users.

babel-preset-stage-3

This preset includes various Babel plugins for JavaScript features that are in stage 3 of the TC39 process, including object rest and spread properties. It is broader in scope compared to babel-plugin-transform-object-rest-spread, which focuses only on object rest and spread properties.