1# entities [![NPM version](http://img.shields.io/npm/v/entities.svg)](https://npmjs.org/package/entities) [![Downloads](https://img.shields.io/npm/dm/entities.svg)](https://npmjs.org/package/entities) [![Build Status](http://img.shields.io/travis/fb55/entities.svg)](http://travis-ci.org/fb55/entities) [![Coverage](http://img.shields.io/coveralls/fb55/entities.svg)](https://coveralls.io/r/fb55/entities)
2
3Encode & decode XML and HTML entities with ease.
4
5## How to…
6
7### …install `entities`
8
9    npm i entities
10
11### …use `entities`
12
13```javascript
14const entities = require("entities");
15
16//encoding
17entities.escape("&"); // "&"
18entities.encodeXML("&"); // "&"
19entities.encodeHTML("&"); // "&"
20
21//decoding
22entities.decodeXML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
23entities.decodeHTML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
24```
25
26## Performance
27
28This is how `entities` compares to other libraries on a very basic benchmark (see `scripts/benchmark.ts`, for 10,000,000 iterations):
29
30| Library        | `decode` performance | `encode` performance |
31| -------------- | -------------------- | -------------------- |
32| entities       | 10.809s              | 17.683s              |
33| html-entities  | 14.029s              | 22.670s              |
34| he             | 16.163s              | 44.010s              |
35| parse-entities | 28.507s              | N/A                  |
36
37---
38
39License: BSD-2-Clause
40
41## Security contact information
42
43To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
44Tidelift will coordinate the fix and disclosure.
45
46## `entities` for enterprise
47
48Available as part of the Tidelift Subscription
49
50The 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)
51