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
/**
* 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: Mon, 06 Nov 2023 22:41:05 GMT
- Dependencies: none
Credits
These definitions were written by Piotr Błażejewicz.