https://github.com/lechidung/escape
Simple library escape or un escape HTML, String, SQL for Deno 🈵 🈵 🈵 💎 🔰
https://github.com/lechidung/escape
deno deno-escape deno-unescape escape escape-html html html-escape
Last synced: 8 months ago
JSON representation
Simple library escape or un escape HTML, String, SQL for Deno 🈵 🈵 🈵 💎 🔰
- Host: GitHub
- URL: https://github.com/lechidung/escape
- Owner: lechidung
- License: mit
- Created: 2020-11-19T16:49:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-01T15:26:27.000Z (over 4 years ago)
- Last Synced: 2025-06-16T00:13:32.066Z (12 months ago)
- Topics: deno, deno-escape, deno-unescape, escape, escape-html, html, html-escape
- Language: TypeScript
- Homepage: https://deno.land/x/escape@1.4.2
- Size: 1.68 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Escape
Simple library for escape or unescape HTML, String, SQL,... for Deno framework.
## API
### Escape HTML
```js
import { escapeHtml } from "https://deno.land/x/escape/mod.ts";
```
#### **1. escapeHtml(string: string): string**
Escape special characters in the given string of text, such that it can be
interpolated in HTML content.
This function will escape the following characters: `"`, `'`, `&`, `<`, and
`>`.
**Note** that the escaped value is only suitable for being interpolated into
HTML as the text content of elements in which the tag does not have different
escaping mechanisms (it cannot be placed inside `` or `<script>`, for
example, as those content bodies are not HTML, but CSS and JavaScript,
respectively; these are known as "raw text elements" in the HTML standard).
#### Example
The `escapeHtml` function is designed to accept a string input of text and
return an escaped value to interpolate into HTML.
```js
import { escapeHtml } from "https://deno.land/x/escape/mod.ts";
console.log(escapeHtml("<script>sample</script>"));
// Result: '<script>sample</script>'
```
#### **2. isEscape(string: string): boolean**
This function will check exist escape the following characters: `"`, `'`, `&`, `<`, and
`>`.
#### Example
```js
import { isEscape } from "https://deno.land/x/escape/mod.ts";
console.log(isEscape("<script>sample</script>"));
// Result: true
```
### Un Escape HTML
```js
import { unescapeHtml } from "https://deno.land/x/escape/mod.ts";
```
#### **1. unescapeHtml(string: string): string**
Convert HTML entities to HTML characters, e.g. > converts to >.
#### Example
The `unescapeHtml` function is designed to accept a string input of text and
return an un-escaped value to interpolate into HTML.
```js
import { unescapeHtml } from "https://deno.land/x/escape/mod.ts";
console.log(unescapeHtml("&lt;script&gt;sample&lt;/script&gt;"));
// Result: '<script>sample</script>'
```
#### **2. isUnescape(string: string): boolean**
This function will check exist unescape the following characters: `&`, `>`, `<`, `:`, `"` and
`'`.
#### Example
```js
import { isUnescape } from "https://deno.land/x/escape/mod.ts";
console.log(isUnescape("&lt;script&gt;sample&lt;/script&gt;"));
// Result: true
```
### Escape SQL
```js
import { escapeSql } from "https://deno.land/x/escape/mod.ts";
```
#### **1. escapeSql(SqlString: string): string**
Escape SQL special characters and quotes in strings.
#### Example
The `unescapeHtml` function is designed to accept a sql string and
return an escaped sql string.
```js
import { escapeSql } from "https://deno.land/x/escape/mod.ts";
console.log(escapeSql("insert into table_exp values('hi, my name''s johnny.');"));
// Result: 'insert into my_table values(\'hi, my name\'\'s johnny.\');'
```
# License
[](./LICENSE)