es-toolkit/docs/reference/string/unescape.md

unescape

Converts the HTML entities &, <, >, ", and ' in str to their corresponding characters. It is the inverse of escape.

Signature

function unescape(str: string): string;

Parameters

• str (string): The string to unescape.

Returns

(string): The unescaped string.

Examples

import { unescape } from 'es-toolkit/string';

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'