es-toolkit/dist/compat/string/unescape.mjs

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

import { unescape as unescape$1 } from "../../string/unescape.mjs";
import { toString } from "../util/toString.mjs";
//#region src/compat/string/unescape.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'
*/
function unescape(str) {
	return unescape$1(toString(str));
}
//#endregion
export { unescape };