# unescape
> Convert HTML entities to HTML characters, e.g. `>` converts to `>`.
Latest version **1.0.1** (published 2017-06-08) · MIT license · 0 weekly downloads
## Install
```sh
npm install unescape
pnpm add unescape
yarn add unescape
bun add unescape
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-06-08 |
| First published | 2014-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 39 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | char, character, characters, entities, entity, escape, html, string, un-escape, unescape, xml |
## Links
- npm: https://www.npmjs.com/package/unescape
- Repository: https://github.com/jonschlinkert/unescape
- Issues: https://github.com/jonschlinkert/unescape/issues
- npm.io page: https://npm.io/package/unescape
## Dependencies (1)
- [extend-shallow](https://npm.io/package/extend-shallow.md) ^2.0.1
## Alternatives
- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads
## Recent versions
- 1.0.1 (latest) — 2017-06-08
- 1.0.0 — 2017-06-04
- 0.2.0 — 2016-11-28
- 0.1.1 — 2014-09-14
- 0.1.0 — 2014-09-14
## README
# unescape [](https://www.npmjs.com/package/unescape) [](https://npmjs.org/package/unescape) [](https://npmjs.org/package/unescape) [](https://travis-ci.org/jonschlinkert/unescape)
> Convert HTML entities to HTML characters, e.g. `>` converts to `>`.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save unescape
```
## Usage
```js
var decode = require('unescape');
console.log(decode('<div>abc</div>'));
//=> 'abc
'
// 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).
### Default entities
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);
```
### Extra entities
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);
```
### All entities
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](https://github.com/mdevils/node-html-entities)
* [ent](https://github.com/substack/node-ent)
## About
### Related projects
* [html-elements](https://www.npmjs.com/package/html-elements): Array of all standard HTML and HTML5 elements. | [homepage](https://github.com/jonschlinkert/html-elements "Array of all standard HTML and HTML5 elements.")
* [html-tag](https://www.npmjs.com/package/html-tag): Generate HTML elements from a javascript object. | [homepage](https://github.com/jonschlinkert/html-tag "Generate HTML elements from a javascript object.")
* [html-toc](https://www.npmjs.com/package/html-toc): Generate a HTML table of contents using cheerio. | [homepage](https://github.com/jonschlinkert/html-toc "Generate a HTML table of contents using cheerio.")
* [is-self-closing](https://www.npmjs.com/package/is-self-closing): Returns true if the given name is a HTML void element or common SVG self-closing… [more](https://github.com/jonschlinkert/is-self-closing) | [homepage](https://github.com/jonschlinkert/is-self-closing "Returns true if the given name is a HTML void element or common SVG self-closing element.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
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
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 04, 2017._
---
_Source: https://npm.io/package/unescape · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._