diff options
Diffstat (limited to 'node_modules/babel-plugin-transform-es2015-block-scoping/README.md')
-rw-r--r-- | node_modules/babel-plugin-transform-es2015-block-scoping/README.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/node_modules/babel-plugin-transform-es2015-block-scoping/README.md b/node_modules/babel-plugin-transform-es2015-block-scoping/README.md new file mode 100644 index 0000000..2890f38 --- /dev/null +++ b/node_modules/babel-plugin-transform-es2015-block-scoping/README.md @@ -0,0 +1,61 @@ +# babel-plugin-transform-es2015-block-scoping + +> Compile ES2015 block scoping (const and let) to ES5 + +## Installation + +```sh +npm install --save-dev babel-plugin-transform-es2015-block-scoping +``` + +## Usage + +### Via `.babelrc` (Recommended) + +**.babelrc** + +Without options: + +```json +{ + "plugins": ["transform-es2015-block-scoping"] +} +``` + +With options: + +```json +{ + "plugins": [ + ["transform-es2015-block-scoping", { + "throwIfClosureRequired": true + }] + ] +} +``` + +### Via CLI + +```sh +babel --plugins transform-es2015-block-scoping script.js +``` + +### Via Node API + +```javascript +require("babel-core").transform("code", { + plugins: ["transform-es2015-block-scoping"] +}); +``` + +## Options `throwIfClosureRequired` + +In cases such as the following it's impossible to rewrite let/const without adding an additional function and closure while transforming: + +```javascript +for (let i = 0; i < 5; i++) { + setTimeout(() => console.log(i), 1); +} +``` + +In extremely performance-sensitive code, this can be undesirable. If `"throwIfClosureRequired": true` is set, Babel throws when transforming these patterns instead of automatically adding an additional function. |