unescape    

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

Install

Install with npm:

``sh
$ npm install --save unescape
`

Usage

`js
var decode = require('unescape');

console.log(decode('<div>abc</div>'));
//=> '

// get the default entities directly
console.log(decode.chars);
`

Characters

For performance, this library only handles the following common entities (split into groups for backward compatibility).

$3

Only the following entities are converted by default.

| Character | Description | Entity Name | Entity Number |
| --- | --- | --- | --- |
| < | less than | < | < |
| > | greater than | > | > |
| & | ampersand | & | & |
| " | double quotation mark | " | " |
| ' | single quotation mark (apostrophe) | ' | ' |

Get the default entities as an object:

`js
console.log(decode.chars);
`

$3

Only the following entities are converted when 'extras' is passed as the second argument.

| Character | Description | Entity Name | Entity Number |
| ¢ | cent | ¢ | ¢ |
| £ | pound | £ | £ |
| ¥ | yen | ¥ | ¥ |
| € | euro | € | € |
| © | copyright | © | © |
| ® | registered trademark | ® | ® |

Example:

`js
// convert only the "extras" characters
decode(str, 'extras');
// get the object of extras characters
console.log(decode.extras);
`

$3

Convert both the defaults and extras:

`js
decode(str, 'all');
`

Get all entities as an object:

`js
console.log(decode.all);
`

Alternatives

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

* html-entities
* ent

About

$3

* html-elements: Array of all standard HTML and HTML5 elements. | homepage
* html-tag: Generate HTML elements from a javascript object. | homepage
* html-toc: Generate a HTML table of contents using cheerio. | homepage
* is-self-closing: Returns true if the given name is a HTML void element or common SVG self-closing… more | homepage

$3

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

$3

_(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)_

To generate the readme, run the following command:

`sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
`

$3

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

`sh
$ npm install && npm test
``

$3

Jon Schlinkert

* github/jonschlinkert
* twitter/jonschlinkert

$3

Copyright © 2017, Jon Schlinkert.
Released under the MIT License.

*

_This file was generated by verb-generate-readme, v0.6.0, on June 04, 2017._