123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 |
- /**
- 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;
|