diff options
Diffstat (limited to 'docs/content/en/functions/safe/JS.md')
-rw-r--r-- | docs/content/en/functions/safe/JS.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/content/en/functions/safe/JS.md b/docs/content/en/functions/safe/JS.md new file mode 100644 index 000000000..e679b5f85 --- /dev/null +++ b/docs/content/en/functions/safe/JS.md @@ -0,0 +1,31 @@ +--- +title: safe.JS +linkTitle: safeJS +description: Declares the provided string as a known safe JavaScript string. +categories: [functions] +keywords: [] +menu: + docs: + parent: functions +function: + aliases: [safeJS] + returnType: template.JS + signatures: [safe.JS INPUT] +relatedFunctions: + - safe.CSS + - safe.HTML + - safe.HTMLAttr + - safe.JS + - safe.JSStr + - safe.URL +aliases: [/functions/safejs] +--- + +In this context, *safe* means the string encapsulates a known safe EcmaScript5 Expression (e.g., `(x + y * z())`). + +Template authors are responsible for ensuring that typed expressions do not break the intended precedence and that there is no statement/expression ambiguity as when passing an expression like `{ foo:bar() }\n['foo']()`, which is both a valid expression and a valid program with a very different meaning. + +Example: Given `hash = "619c16f"` defined in the front matter of your `.md` file: + +* <span class="good">`<script>var form_{{ .Params.hash | safeJS }};…</script>` → `<script>var form_619c16f;…</script>`</span> +* <span class="bad">`<script>var form_{{ .Params.hash }};…</script>` → `<script>var form_"619c16f";…</script>`</span> |