html-entities
Advanced tools
Package description
The html-entities package is a utility for encoding and decoding HTML entities. It can encode and decode a wide range of characters, including special characters, symbols, and emojis, to their corresponding HTML entities and vice versa. This is useful for preventing XSS attacks, rendering special characters in web pages, and working with text that includes characters that need to be escaped in HTML.
Encode special characters to HTML entities
This feature allows you to convert characters that have special meaning in HTML into their corresponding entities, making it safe to insert the text into HTML documents.
const { encode } = require('html-entities');
const result = encode('<div>Hello & Welcome!</div>');
console.log(result); // <div>Hello & Welcome!</div>Decode HTML entities to their original characters
This feature enables you to convert HTML entities back into their original characters, which is useful when you need to process or display the text as it was originally intended.
const { decode } = require('html-entities');
const result = decode('<div>Hello & Welcome!</div>');
console.log(result); // <div>Hello & Welcome!</div>Support for all HTML5 entities
The package includes support for all named HTML5 entities, allowing you to encode and decode a comprehensive set of characters.
const { encode } = require('html-entities');
const result = encode('© ∆');
console.log(result); // © ΔHandling of non-ASCII characters
This feature is specifically for encoding non-ASCII characters into their numerical HTML entity equivalents, which can be important for internationalization and dealing with various character sets.
const { encodeNonAsciiHTML } = require('html-entities');
const result = encodeNonAsciiHTML('Привет!');
console.log(result); // Привет!The 'he' package is an HTML entity encoder/decoder written in JavaScript. It is robust and handles a large number of character references. Compared to html-entities, 'he' claims to be the fastest and most comprehensive HTML entity library, and it strictly adheres to the HTML5 specification.
The 'entities' package is another library for encoding and decoding HTML entities. It is used internally by the 'htmlparser2' library, which is a fast and forgiving HTML/XML parser. While 'entities' offers similar functionality to html-entities, it is particularly optimized for use with 'htmlparser2' and may be more suitable for parsing tasks.
Readme
Fastest html entities library.
$ npm install html-entities
Encodes text replacing HTML special characters (<>&"') plus other character ranges depending on mode option value.
import {encode} from 'html-entities';
encode('<>"\'&©∆')
// -> '<>"'&©∆'
encode('<>"\'&©∆', {mode: 'nonAsciiPrintable'})
// -> '<>"'&©∆'
encode('<>"\'&©∆', {mode: 'nonAsciiPrintable', level: 'xml'})
// -> '<>"'&©∆'
Options:
all alias to html5 (default).html5 uses HTML5 named references.html4 uses HTML4 named references.xml uses XML named references.specialChars encodes only HTML special characters (default).nonAscii encodes HTML special characters and everything outside of the ASCII character range.nonAsciiPrintable encodes HTML special characters and everything outiside of the ASCII printable characters.decimal uses decimal numbers when encoding html entities. i.e. © (default).hexadecimal uses hexadecimal numbers when encoding html entities. i.e. ©.Decodes text replacing entities to characters. Unknown entities are left as is.
import {decode} from 'html-entities';
decode('<>"'&©∆')
// -> '<>"\'&©∆'
decode('©', {level: 'html5'})
// -> '©'
decode('©', {level: 'xml'})
// -> '©'
Options:
all alias to html5 (default).html5 uses HTML5 named references.html4 uses HTML4 named references.xml uses XML named references.=.Statistically significant comparison with other libraries using benchmark.js.
Results by this library are marked with *.
The source code of the benchmark is available at benchmark/benchmark.ts.
HTML
Encode test
* #1: html-entities.encode - html5, specialChars x 1,218,530 ops/sec ±0.30% (94 runs sampled)
* #2: html-entities.encode - html5, nonAscii x 468,875 ops/sec ±0.38% (95 runs sampled)
* #3: html-entities.encode - html5, nonAsciiPrintable x 426,809 ops/sec ±0.60% (96 runs sampled)
#4: entities.encodeHTML5 x 132,621 ops/sec ±0.38% (91 runs sampled)
#5: he.encode x 119,645 ops/sec ±1.54% (93 runs sampled)
Decode test
* #1: html-entities.decode - html5, strict x 356,322 ops/sec ±0.50% (93 runs sampled)
* #2: html-entities.decode - html5, body x 348,765 ops/sec ±2.20% (94 runs sampled)
* #3: html-entities.decode - html5, attribute x 334,330 ops/sec ±0.29% (98 runs sampled)
#4: entities.decodeHTML4 x 301,096 ops/sec ±0.44% (96 runs sampled)
#5: entities.decodeHTML5 x 298,314 ops/sec ±2.12% (95 runs sampled)
#6: he.decode x 214,220 ops/sec ±2.01% (91 runs sampled)
XML
Encode test
#1: he.escape x 1,229,701 ops/sec ±0.40% (97 runs sampled)
* #2: html-entities.encode - xml, specialChars x 1,143,625 ops/sec ±1.90% (96 runs sampled)
* #3: html-entities.encode - xml, nonAscii x 443,845 ops/sec ±0.33% (93 runs sampled)
* #4: html-entities.encode - xml, nonAsciiPrintable x 418,533 ops/sec ±0.48% (94 runs sampled)
#5: entities.encodeXML x 303,733 ops/sec ±2.09% (91 runs sampled)
#6: entities.escape x 233,410 ops/sec ±0.43% (95 runs sampled)
Decode test
* #1: html-entities.decode - xml, body x 409,645 ops/sec ±0.43% (93 runs sampled)
#2: entities.decodeXML x 417,140 ops/sec ±2.42% (91 runs sampled)
* #3: html-entities.decode - xml, attribute x 406,512 ops/sec ±0.99% (97 runs sampled)
* #4: html-entities.decode - xml, strict x 398,532 ops/sec ±2.54% (93 runs sampled)
#5: entities.decodeXMLStrict x 377,224 ops/sec ±5.69% (85 runs sampled)
#6: he.unescape x 250,981 ops/sec ±2.57% (93 runs sampled)
MIT
FAQs
Fastest HTML entities encode/decode library.
We found that html-entities demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.