README

Unescape-es6

Convert HTML entities to HTML characters, e.g. `>` converts to `>`.

Based on unescape from jonschlinkert but updated for ES6

Install

Install with yarn:

$ yarn add unescape

Usage

const { unescape } = require('unescape-es6');
// or for TypeScript:
// import { unescape } from 'unescape-es6';

console.log(unescape('&lt;div&gt;abc&lt;/div&gt;'));
//=> '<div>abc</div>'

// use template tags
console.log(unescape`&lt;div&gt;abc&lt;/div&gt;`); // => '<div>abc</div>'

// or with variables
const unescaped = '&lt;div&gt;unescaped&lt;/div&gt;';
console.log(unescape`awesome text with some ${unescaped} section`); //=> 'awesome text with some <div>unescaped</div> section'

Characters

For performance, this library only handles the following common entities

Only the following entities are converted by default.

Character	Description	Entity Name	Entity Decimal	Entity Hex
`"`	double quotation mark	`"`	`"`	`"`
`'`	single quotation mark (apostrophe)	`'`	`'`	`'`
`&`	ampersand	`&`	`&`	`&`
`>`	greater than	`>`	`>`	`>`
`<`	less than	`<`	`<`	`<`
	Single regular space	` `	`N.A`	` `
`©`	copyright	`©`	`©`	`©`
`¢`	cent	`¢`	`¢`	`¢`
`®`	registered trademark	`®`	`®`	`®`
`€`	euro	`€`	`€`	`N.A.`
`£`	pound	`£`	`£`	`£`
`¥`	yen	`¥`	`¥`	`¥`

You can also print characters in runtime:

const { charSets } = require('unescape-es6');

console.log(charSets);

About

Alternatives

If you need a more robust implementation, try one of the following libraries:

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

License

Buy me a donut

This project is open source and always will be, even if I don't get donations. That said, I know there are people out there that may still want to donate just to show their appreciation so this is for you guys. Thanks in advance!

I accept donations through PayPal, BitCoin, Ethereum and LiteCoin. You can use the buttons below to donate through your method of choice