summaryrefslogtreecommitdiffstats
path: root/node_modules/babel-plugin-transform-es2015-computed-properties/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/babel-plugin-transform-es2015-computed-properties/README.md')
-rw-r--r--node_modules/babel-plugin-transform-es2015-computed-properties/README.md130
1 files changed, 130 insertions, 0 deletions
diff --git a/node_modules/babel-plugin-transform-es2015-computed-properties/README.md b/node_modules/babel-plugin-transform-es2015-computed-properties/README.md
new file mode 100644
index 0000000..4a7c74d
--- /dev/null
+++ b/node_modules/babel-plugin-transform-es2015-computed-properties/README.md
@@ -0,0 +1,130 @@
+# babel-plugin-transform-es2015-computed-properties
+
+> Compile ES2015 computed properties to ES5
+
+## Example
+
+**In**
+
+```js
+var obj = {
+ ["x" + foo]: "heh",
+ ["y" + bar]: "noo",
+ foo: "foo",
+ bar: "bar"
+};
+```
+
+**Out**
+
+```js
+var _obj;
+
+function _defineProperty(obj, key, value) {
+ if (key in obj) {
+ Object.defineProperty(obj, key, {
+ value: value,
+ enumerable: true,
+ configurable: true,
+ writable: true
+ });
+ } else {
+ obj[key] = value;
+ }
+
+ return obj;
+}
+
+var obj = (
+ _obj = {},
+ _defineProperty(_obj, "x" + foo, "heh"),
+ _defineProperty(_obj, "y" + bar, "noo"),
+ _defineProperty(_obj, "foo", "foo"),
+ _defineProperty(_obj, "bar", "bar"),
+ _obj
+);
+```
+
+## Installation
+
+```sh
+npm install --save-dev babel-plugin-transform-es2015-computed-properties
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+Without options:
+
+```json
+{
+ "plugins": ["transform-es2015-computed-properties"]
+}
+```
+
+With options:
+
+```json
+{
+ "plugins": [
+ ["transform-es2015-computed-properties", {
+ "loose": true
+ }]
+ ]
+}
+```
+
+### Via CLI
+
+```sh
+babel --plugins transform-es2015-computed-properties script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+ plugins: ["transform-es2015-computed-properties"]
+});
+```
+
+## Options
+
+### `loose`
+
+`boolean`, defaults to `false`
+
+Just like method assignment in classes, in loose mode, computed property names
+use simple assignments instead of being defined. This is unlikely to be an issue
+in production code.
+
+#### Example
+
+***In***
+
+```js
+var obj = {
+ ["x" + foo]: "heh",
+ ["y" + bar]: "noo",
+ foo: "foo",
+ bar: "bar"
+};
+```
+
+***Out***
+
+```js
+var _obj;
+
+var obj = (
+ _obj = {},
+ _obj["x" + foo] = "heh",
+ _obj["y" + bar] = "noo",
+ _obj.foo = "foo",
+ _obj.bar = "bar",
+ _obj
+);
+```