1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
# Installation
> `npm install --save @types/escape-html`
# Summary
This package contains type definitions for escape-html (https://github.com/component/escape-html).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/escape-html.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/escape-html/index.d.ts)
````ts
// Type definitions for escape-html 1.0
// Project: https://github.com/component/escape-html
// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/**
* Escape string for use in HTML
*/
/**
* 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
* `<style>` 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).
*
* *Note* when using the escaped value within a tag, it is only suitable as the value of an attribute,
* where the value is quoted with either a double quote character (`"`) or a single quote character (`'`).
*/
declare function escapeHTML(text?: string | null): string;
export = escapeHTML;
````
### Additional Details
* Last updated: Thu, 14 Apr 2022 17:01:30 GMT
* Dependencies: none
* Global values: none
# Credits
These definitions were written by [Piotr Błażejewicz](https://github.com/peterblazejewicz).
|
