aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@babel/plugin-transform-template-literals/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/@babel/plugin-transform-template-literals/README.md')
-rw-r--r--node_modules/@babel/plugin-transform-template-literals/README.md85
1 files changed, 85 insertions, 0 deletions
diff --git a/node_modules/@babel/plugin-transform-template-literals/README.md b/node_modules/@babel/plugin-transform-template-literals/README.md
new file mode 100644
index 00000000..d22f3b92
--- /dev/null
+++ b/node_modules/@babel/plugin-transform-template-literals/README.md
@@ -0,0 +1,85 @@
+# @babel/plugin-transform-template-literals
+
+> Compile ES2015 template literals to ES5
+
+## Example
+
+**In**
+
+```javascript
+`foo${bar}`;
+```
+
+**Out**
+
+```javascript
+"foo".concat(bar);
+```
+
+## Installation
+
+```sh
+npm install --save-dev @babel/plugin-transform-template-literals
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+Without options:
+
+```json
+{
+ "plugins": ["@babel/plugin-transform-template-literals"]
+}
+```
+
+With options:
+
+```json
+{
+ "plugins": [
+ ["@babel/plugin-transform-template-literals", {
+ "loose": true
+ }]
+ ]
+}
+```
+
+### Via CLI
+
+```sh
+babel --plugins @babel/plugin-transform-template-literals script.js
+```
+
+### Via Node API
+
+```javascript
+require("@babel/core").transform("code", {
+ plugins: ["@babel/plugin-transform-template-literals"]
+});
+```
+
+## Options
+
+### `loose`
+
+`boolean`, defaults to `false`.
+
+When `true`, tagged template literal objects aren't frozen. All template literal expressions and quasis are combined with the `+` operator instead of with `String.prototype.concat`.
+
+When `false` or not set, all template literal expressions and quasis are combined with `String.prototype.concat`. It will handle cases with `Symbol.toPrimitive` correctly and throw correctly if template literal expression is a `Symbol()`. See [babel/babel#5791](https://github.com/babel/babel/pull/5791).
+
+**In**
+
+```javascript
+`foo${bar}`;
+```
+
+**Out**
+
+```javascript
+"foo" + bar;
+```