diff options
author | Minteck <contact@minteck.org> | 2022-06-04 08:51:01 +0200 |
---|---|---|
committer | Minteck <contact@minteck.org> | 2022-06-04 08:51:01 +0200 |
commit | 383285ecd5292bf9a825e05904955b937de84cc9 (patch) | |
tree | 0a53b6f02c1604b078044567c03dc1b6c944c8c2 /node_modules/escape-goat/index.d.ts | |
download | equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.gz equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.bz2 equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.zip |
Initial commit
Diffstat (limited to 'node_modules/escape-goat/index.d.ts')
-rw-r--r-- | node_modules/escape-goat/index.d.ts | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/node_modules/escape-goat/index.d.ts b/node_modules/escape-goat/index.d.ts new file mode 100644 index 0000000..4f46024 --- /dev/null +++ b/node_modules/escape-goat/index.d.ts @@ -0,0 +1,62 @@ +/** +Escape a string for use in HTML. + +Escapes the following characters in the given `string` argument: `&` `<` `>` `"` `'`. + +@example +``` +import {htmlEscape} from 'escape-goat'; + +htmlEscape('🦄 & 🐐'); +//=> '🦄 & 🐐' + +htmlEscape('Hello <em>World</em>'); +//=> 'Hello <em>World</em>' +``` +*/ +export function htmlEscape(string: string): string; + +/** +Unescape an HTML string to use as a plain string. + +Unescapes the following HTML entities in the given `htmlString` argument: `&` `<` `>` `"` `'`. + +@example +``` +import {htmlUnescape} from 'escape-goat'; + +htmlUnescape('🦄 & 🐐'); +//=> '🦄 & 🐐' +``` +*/ +export function htmlUnescape(htmlString: string): string; + +/** +[Tagged template literal](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Template_literals#Tagged_template_literals) that escapes interpolated values. + +@example +``` +import {htmlEscapeTag} from 'escape-goat'; + +const url = 'https://sindresorhus.com?x="🦄"'; + +htmlEscapeTag`<a href="${url}">Unicorn</a>`; +//=> '<a href="https://sindresorhus.com?x="🦄"">Unicorn</a>' +``` +*/ +export function htmlEscapeTag(template: TemplateStringsArray, ...substitutions: readonly unknown[]): string; + +/** +[Tagged template literal](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Template_literals#Tagged_template_literals) that unescapes interpolated values. + +@example +``` +import {htmlUnescapeTag} from 'escape-goat'; + +const escapedUrl = 'https://sindresorhus.com?x="🦄"'; + +htmlUnescapeTag`URL from HTML: ${url}`; +//=> 'URL from HTML: https://sindresorhus.com?x="🦄"' +``` +*/ +export function htmlUnescapeTag(template: TemplateStringsArray, ...substitutions: readonly unknown[]): string; |