History

Luna 4f63b4f9a0 first commit		2021-07-27 18:40:12 -07:00
..
lib	first commit	2021-07-27 18:40:12 -07:00
LICENSE	first commit	2021-07-27 18:40:12 -07:00
package.json	first commit	2021-07-27 18:40:12 -07:00
readme.md	first commit	2021-07-27 18:40:12 -07:00

readme.md

entities

Encode & decode XML and HTML entities with ease.

How to…

…install `entities`

npm i entities

…use `entities`

const entities = require("entities");

//encoding
entities.escape("&#38;"); // "&#x26;#38;"
entities.encodeXML("&#38;"); // "&amp;#38;"
entities.encodeHTML("&#38;"); // "&amp;&num;38&semi;"

//decoding
entities.decodeXML("asdf &amp; &#xFF; &#xFC; &apos;"); // "asdf & ÿ ü '"
entities.decodeHTML("asdf &amp; &yuml; &uuml; &apos;"); // "asdf & ÿ ü '"

Performance

This is how entities compares to other libraries on a very basic benchmark (see scripts/benchmark.ts, for 10,000,000 iterations):

Library	`decode` performance	`encode` performance
entities	10.809s	17.683s
html-entities	14.029s	22.670s
he	16.163s	44.010s
parse-entities	28.507s	N/A

License: BSD-2-Clause

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 use. Learn more.