From 383285ecd5292bf9a825e05904955b937de84cc9 Mon Sep 17 00:00:00 2001 From: Minteck Date: Sat, 4 Jun 2022 08:51:01 +0200 Subject: Initial commit --- node_modules/escape-goat/index.d.ts | 62 +++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 node_modules/escape-goat/index.d.ts (limited to 'node_modules/escape-goat/index.d.ts') 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 World'); +//=> '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`Unicorn`; +//=> 'Unicorn' +``` +*/ +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; -- cgit