summaryrefslogtreecommitdiffstats
path: root/node_modules/babel-preset-flow/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/babel-preset-flow/README.md')
-rw-r--r--node_modules/babel-preset-flow/README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/node_modules/babel-preset-flow/README.md b/node_modules/babel-preset-flow/README.md
new file mode 100644
index 0000000..26593bd
--- /dev/null
+++ b/node_modules/babel-preset-flow/README.md
@@ -0,0 +1,53 @@
+# babel-preset-flow
+
+> Babel preset for all Flow plugins.
+
+This preset includes the following plugins:
+
+- [transform-flow-strip-types](https://babeljs.io/docs/plugins/transform-flow-strip-types/)
+
+## Example
+
+**In**
+
+```javascript
+function foo(one: any, two: number, three?): string {}
+```
+
+**Out**
+
+```javascript
+function foo(one, two, three) {}
+```
+
+## Installation
+
+```sh
+npm install --save-dev babel-preset-flow
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+```json
+{
+ "presets": ["flow"]
+}
+```
+
+### Via CLI
+
+```sh
+babel --presets flow script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+ presets: ["flow"]
+});
+```