Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

js-htmlencode

emn178113.2kMIT0.3.0TypeScript support: included

A simple HTML encode / decode function for JavaScript.

htmlencode, htmldecode, encode, decode

readme

js-htmlencode

Build Status Build Status
NPM
A simple HTML encode / decode function for JavaScript.

Demo

HTML Encode Online
HTML Decode Online

Download

Compress
Uncompress

Installation

You can also install js-htmlencode by using Bower.

bower install js-htmlencode

For node.js, you can use this command to install:

npm install js-htmlencode

Usage

You could use like this:

htmlEncode('Html to encode');
htmlDecode('String to decode');

If you use node.js, you should require the module first:

var htmlEncode = require('js-htmlencode');

Or

var htmlEncode = require('js-htmlencode').htmlEncode;
var htmlDecode = require('js-htmlencode').htmlDecode;

It supports AMD:

require(['your/path/htmlencode.js'], function (htmlEncode) {
  var htmlEncode = htmlEncode.htmlEncode;
  var htmlDecode = htmlDecode.htmlDecode;
  // ...
});
For TypeScript
```TypeScript
import { htmlEncode, htmlDecode } from 'js-htmlencode';
htmlEncode('ooo');
htmlDecode('xxx');

Example

htmlEncode('<a href="#">HTML Encode</a>'); // &lt;a href=&quot;#&quot;&gt;HTML Encode&lt;/a&gt;
htmlDecode('&lt;a href=&quot;#&quot;&gt;HTML Encode&lt;/a&gt;'); // <a href="#">HTML Encode</a>
htmlDecode('<a href="#">HTML Encode</a>'); // <a href="#">HTML Encode</a>

License

The project is released under the MIT license.

Contact

The project's website is located at https://github.com/emn178/js-htmlencode
Author: Chen, Yi-Cyuan (emn178@gmail.com)

changelog

Change Log

v0.3.0 / 2017-02-10

Added

  • AMD support.

Fixed

  • root is undefined in some special environment.

v0.2.0 / 2016-08-30

Added

  • TypeScript support.
  • unit tests to 100% coverage.

v0.1.1 / 2015-01-09

Added

  • bower package.
  • coveralls.

Improved

  • test framework.

v0.1.0 / 2014-12-30

Added

  • create project.