html-entities

Fast html entities library.

Installation

$ npm install html-entities

Usage

XML entities

HTML validity and XSS attack prevention you can achieve from XmlEntities class.

const Entities = require('html-entities').XmlEntities;

const entities = new Entities();

console.log(entities.encode('<>"\'&amp;©®')); // &amp;lt;&amp;gt;&amp;quot;&amp;apos;&amp;amp;©®
console.log(entities.encodeNonUTF('<>"\'&amp;©®')); // &amp;lt;&amp;gt;&amp;quot;&amp;apos;&amp;amp;&amp;#169;&amp;#174;
console.log(entities.encodeNonASCII('<>"\'&amp;©®')); // <>"\'&amp;©®
console.log(entities.decode('&amp;lt;&amp;gt;&amp;quot;&amp;apos;&amp;amp;&amp;copy;&amp;reg;&amp;#8710;')); // <>"'&amp;&amp;copy;&amp;reg;∆

All HTML entities encoding/decoding

const Entities = require('html-entities').AllHtmlEntities;

const entities = new Entities();

console.log(entities.encode('<>"&amp;©®∆')); // &amp;lt;&amp;gt;&amp;quot;&amp;amp;&amp;copy;&amp;reg;∆
console.log(entities.encodeNonUTF('<>"&amp;©®∆')); // &amp;lt;&amp;gt;&amp;quot;&amp;amp;&amp;copy;&amp;reg;&amp;#8710;
console.log(entities.encodeNonASCII('<>"&amp;©®∆')); // <>"&amp;©®&amp;#8710;
console.log(entities.decode('&amp;lt;&amp;gt;&amp;quot;&amp;amp;&amp;copy;&amp;reg;')); // <>"&amp;©®

Available classes

const XmlEntities = require('html-entities').XmlEntities, // <>"'&amp; + &amp;#...; decoding
      Html4Entities = require('html-entities').Html4Entities, // HTML4 entities.
      Html5Entities = require('html-entities').Html5Entities, // HTML5 entities.
      AllHtmlEntities = require('html-entities').AllHtmlEntities; // Synonym for HTML5 entities.

Supports four methods for every class:

• encode — encodes, replacing characters to its entity representations. Ignores UTF characters with no entity representation.
• encodeNonUTF — encodes, replacing characters to its entity representations. Inserts numeric entities for UTF characters.
• encodeNonASCII — encodes, replacing only non-ASCII characters to its numeric entity representations.
• decode — decodes, replacing entities to characters. Unknown entities are left as is.