Reference · Markup

escape

escape(any) -> str

What it does

The value's text with & < > " ' written as entities (& < > " '), safe to put inside an element or an attribute. Markup escapes text by itself, so this is for HTML built as a string: a piece you then mark with raw, or text written into a file. Any value is taken; its text is what str gives.

Examples

print(escape("<b>Tom & Jerry's \"show\"</b>"))print(escape(42), escape(true), escape("plain"))

<b>Tom & Jerry's "show"</b>42 true plain

Edge cases

• An html value is escaped like text: escape(markdown(...)) shows the tags.
• Escaping twice doubles the entities: < becomes <.
• null gives the text null, not the empty string.
• A list or a map gives its printed form, escaped.
• Letters outside ASCII, \n and spaces stay as they are. A CR is written 
 and a NUL U+FFFD, here and in markup, on the server and in the browser, so a note typed in a <textarea> and posted with CRLF is taken up as written.

print(escape(markdown("*a*")))print(escape(escape("<")))print(escape(null), escape(""))print(escape([1, "<"]), escape({ a: "<" }))print(escape("héllo\n😀"))

<p><em>a</em></p><null [1, "<"] { a: "<" }héllo😀

Errors

None: every value has a text, so escape never fails and never gives an error value. An error value is shown as err(...), escaped.

print(escape(err("<bad>")))

err("<bad>")

Chaining

print(["<a>", "b & c"] | map(escape) | join(", "))let cell = "<script>" | escapeprint(raw(`<td>${cell}</td>`))

&lt;a&gt;, b &amp; c<td>&lt;script&gt;</td>

See also

raw, url_encode, markdown, str

Edit this page on GitHub · every example's output was made by running it (tools/refcheck.mjs) · questions on Discord or r/quillo