Encode & decode HTML & XML entities with ease & speed.
😇Tried and true:
entitiesis used by many popular libraries; eg.
htmlparser2, the official AWS SDK and
commonmarkuse it to process HTML entities.
entitiesis the fastest library for decoding HTML entities (as of April 2022); see performance.
🎛Configurable: Get an output tailored for your needs. You are fine with UTF8? That'll save you some bytes. Prefer to only have ASCII characters? We can do that as well!
npm install entities
const entities = require("entities"); // Encoding entities.escapeUTF8("& ü"); // "&#38; ü" entities.encodeXML("& ü"); // "&#38; ü" entities.encodeHTML("& ü"); // "&#38; ü" // Decoding entities.decodeXML("asdf & ÿ ü '"); // "asdf & ÿ ü '" entities.decodeHTML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
This is how
entities compares to other libraries on a very basic benchmark
scripts/benchmark.ts, for 10,000,000 iterations; lower is better):
What methods should I actually use to encode my documents?
If your target supports UTF-8, the
escapeUTF8 method is going to be your best
choice. Otherwise, use either
encodeXML based on whether
you're dealing with an HTML or an XML document.
You can have a look at the options for the
decode methods to see
everything you can configure.
When should I use strict decoding?
When strict decoding, entities not terminated with a semicolon will be ignored. This is helpful for decoding entities in legacy environments.
Why should I use
entitiesinstead of alternative modules?
As of April 2022,
entities is a bit faster than other modules. Still, this is
not a very differentiated space and other modules can catch up.
More importantly, you might already have
entities in your dependency graph
(as a dependency of eg.
htmlparser2), and including it directly
might not even increase your bundle size. The same is true for other entity
libraries, so have a look through your
entitiessupport tree shaking?
entities ships as both a CommonJS and a ES module. Note that for best
results, you should not use the
decode functions, as they wrap
around a number of other functions, all of which will remain in the bundle.
Instead, use the functions that you need directly.
This library wouldn't be possible without the work of these individuals. Thanks to
@mathiasbynens for his explanations
about character encodings, and his library
he, which was one of the inspirations for
@inikulin for his work on optimized tries for
decoding HTML entities for the
@mdevils for taking on the challenge of
producing a quick entity library with his
entitieswould be quite a bit slower if there wasn't any competition. Right now
entitiesis on top, but we'll see how long that lasts!
Security contact information
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
entities for enterprise
Available as part of the Tidelift Subscription
The maintainers of
entities and thousands of other packages are working with
Tidelift to deliver commercial support and maintenance for the open source
dependencies you use to build your applications. Save time, reduce risk, and
improve code health, while paying the maintainers of the exact dependencies you