|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 |
- # entities [](https://npmjs.org/package/entities) [](https://npmjs.org/package/entities) [](http://travis-ci.org/fb55/entities) [](https://coveralls.io/r/fb55/entities)
-
- Encode & decode HTML & XML entities with ease & speed.
-
- ## How to…
-
- ### …install `entities`
-
- npm install entities
-
- ### …use `entities`
-
- ```javascript
- const entities = require("entities");
-
- //encoding
- entities.escape("&"); // "&"
- entities.encodeXML("&"); // "&"
- entities.encodeHTML("&"); // "&"
-
- //decoding
- entities.decodeXML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
- entities.decodeHTML("asdf & ÿ ü '"); // "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 | Bundle size |
- | -------------- | -------------------- | -------------------- | -------------------------------------------------------------------------- |
- | 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](https://tidelift.com/security). 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.](https://tidelift.com/subscription/pkg/npm-entities?utm_source=npm-entities&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
|