db3ebd0df0 | ||
---|---|---|
.. | ||
lib | ||
LICENSE | ||
README.md | ||
package.json |
README.md
node-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('<>"\'&©®')); // <>"'&©®
console.log(entities.encodeNonUTF('<>"\'&©®')); // <>"'&©®
console.log(entities.encodeNonASCII('<>"\'&©®')); // <>"\'&©®
console.log(entities.decode('<>"'&©®∆')); // <>"'&©®∆
All HTML entities encoding/decoding
const Entities = require('html-entities').AllHtmlEntities;
const entities = new Entities();
console.log(entities.encode('<>"&©®∆')); // <>"&©®∆
console.log(entities.encodeNonUTF('<>"&©®∆')); // <>"&©®∆
console.log(entities.encodeNonASCII('<>"&©®∆')); // <>"&©®∆
console.log(entities.decode('<>"&©®')); // <>"&©®
Available classes
const XmlEntities = require('html-entities').XmlEntities, // <>"'& + &#...; 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.