Files
bun.sh/docs/guides/util/escape-html.md
2024-09-10 15:11:16 -07:00

23 lines
613 B
Markdown

---
name: Escape an HTML string
---
The `Bun.escapeHTML()` utility can be used to escape HTML characters in a string. The following replacements are made.
- `"` becomes `"""`
- `&` becomes `"&"`
- `'` becomes `"'"`
- `<` becomes `"&lt;"`
- `>` becomes `"&gt;"`
This function is optimized for large input. Non-string types will be converted to a string before escaping.
```ts
Bun.escapeHTML("<script>alert('Hello World!')</script>");
// &lt;script&gt;alert(&#x27;Hello World!&#x27;)&lt;&#x2F;script&gt;
```
---
See [Docs > API > Utils](https://bun.sh/docs/api/utils) for more useful utilities.