summaryrefslogtreecommitdiffstats
path: root/node_modules/babel-plugin-transform-class-properties/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-class-properties/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-class-properties/README.md')
-rw-r--r--node_modules/babel-plugin-transform-class-properties/README.md87
1 files changed, 87 insertions, 0 deletions
diff --git a/node_modules/babel-plugin-transform-class-properties/README.md b/node_modules/babel-plugin-transform-class-properties/README.md
new file mode 100644
index 0000000..49f4822
--- /dev/null
+++ b/node_modules/babel-plugin-transform-class-properties/README.md
@@ -0,0 +1,87 @@
+# babel-plugin-transform-class-properties
+
+> This plugin transforms es2015 static class properties as well as properties declared with the es2016 property initializer syntax.
+
+## Example
+
+Below is a class with four class properties which will be transformed.
+
+```js
+ class Bork {
+ //Property initializer syntax
+ instanceProperty = "bork";
+ boundFunction = () => {
+ return this.instanceProperty;
+ }
+
+ //Static class properties
+ static staticProperty = "babelIsCool";
+ static staticFunction = function() {
+ return Bork.staticProperty;
+ }
+ }
+
+ let myBork = new Bork;
+
+ //Property initializers are not on the prototype.
+ console.log(myBork.prototype.boundFunction); // > undefined
+
+ //Bound functions are bound to the class instance.
+ console.log(myBork.boundFunction.call(undefined)); // > "bork"
+
+ //Static function exists on the class.
+ console.log(Bork.staticFunction()); // > "babelIsCool"
+```
+
+
+## Installation
+
+```sh
+npm install --save-dev babel-plugin-transform-class-properties
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+```json
+// without options
+{
+ "plugins": ["transform-class-properties"]
+}
+
+// with options
+{
+ "plugins": [
+ ["transform-class-properties", { "spec": true }]
+ ]
+}
+```
+
+### Via CLI
+
+```sh
+babel --plugins transform-class-properties script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+ plugins: ["transform-class-properties"]
+});
+```
+
+## Options
+
+### `spec`
+
+`boolean`, defaults to `false`.
+
+Class properties are compiled to use `Object.defineProperty`. Static fields are now defined even if they are not initialized.
+
+## References
+
+* [Proposal: ES Class Fields & Static Properties](https://github.com/jeffmo/es-class-static-properties-and-fields)