es-toolkit/dist/compat/string/unescape.d.ts

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

//#region src/compat/string/unescape.d.ts
/**
 * Converts the HTML entities `&`, `<`, `>`, `"`, and `'` in `str` to their corresponding characters.
 * It is the inverse of `escape`.
 *
 * @param str The string to unescape.
 * @returns Returns the unescaped string.
 *
 * @example
 * unescape('This is a &lt;div&gt; element.'); // returns 'This is a <div> element.'
 * unescape('This is a &quot;quote&quot;'); // returns 'This is a "quote"'
 * unescape('This is a &#39;quote&#39;'); // returns 'This is a 'quote''
 * unescape('This is a &amp; symbol'); // returns 'This is a & symbol'
 */
declare function unescape(str?: string): string;
//#endregion
export { unescape };