Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

unescape

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

unescape

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

  • 1.0.1
  • unpublished
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

unescape NPM version NPM monthly downloads NPM total downloads Linux Build Status

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

Install

Install with npm:

$ npm install --save unescape

Usage

var decode = require('unescape');

console.log(decode('<div>abc</div>'));
//=> '<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).

Default entities

Only the following entities are converted by default.

CharacterDescriptionEntity NameEntity Number
<less than&lt;&#60;
>greater than&gt;&#62;
&ampersand&amp;&#38;
"double quotation mark&quot;&#34;
'single quotation mark (apostrophe)&apos;&#39;

Get the default entities as an object:

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 | &cent; | &#162; | | £ | pound | &pound; | &#163; | | ¥ | yen | &yen; | &#165; | | | euro | &euro; | &#8364; | | © | copyright | &copy; | &#169; | | ® | registered trademark | &reg; | &#174; |

Example:

// 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:

decode(str, 'all');

Get all entities as an object:

console.log(decode.all);

Alternatives

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

About

Contributing

Pull 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 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:

$ npm install && npm test

Author

Jon Schlinkert

License

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


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

Keywords

FAQs

Package last updated on 08 Jun 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc