Convert HTML entities to HTML characters, e.g.
InstallInstall with npm:
$ npm install --save unescape
var decode = require('unescape'); console.log(decode('<div>abc</div>')); //=> '<div>abc</div>' // get the default entities directly console.log(decode.chars);
CharactersFor performance, this library only handles the following common entities (split into groups for backward compatibility).
Default entitiesOnly 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:
Extra entitiesOnly 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 |
// convert only the "extras" characters decode(str, 'extras'); // get the object of `extras` characters console.log(decode.extras);
All entitiesConvert both the defaults and extras:
Get all entities as an object:
AlternativesIf you need a more robust implementation, try one of the following libraries:
- html-elements: Array of all standard HTML and HTML5 elements. | 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
ContributingPull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs(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:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running testsRunning 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:
$ npm install && npm test
LicenseCopyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on June 04, 2017.