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 HTML & XML entities with ease & speed. 4 5## How to… 6 7### …install `entities` 8 9 npm install 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 29(see `scripts/benchmark.ts`, for 10,000,000 iterations): 30 31| Library | `decode` performance | `encode` performance | Bundle size | 32| -------------- | -------------------- | -------------------- | -------------------------------------------------------------------------- | 33| entities | 10.809s | 17.683s | ![npm bundle size](https://img.shields.io/bundlephobia/min/entities) | 34| html-entities | 14.029s | 22.670s | ![npm bundle size](https://img.shields.io/bundlephobia/min/html-entities) | 35| he | 16.163s | 44.010s | ![npm bundle size](https://img.shields.io/bundlephobia/min/he) | 36| parse-entities | 28.507s | N/A | ![npm bundle size](https://img.shields.io/bundlephobia/min/parse-entities) | 37 38--- 39 40License: BSD-2-Clause 41 42## Security contact information 43 44To report a security vulnerability, please use the 45[Tidelift security contact](https://tidelift.com/security). Tidelift will 46coordinate the fix and disclosure. 47 48## `entities` for enterprise 49 50Available as part of the Tidelift Subscription 51 52The maintainers of `entities` and thousands of other packages are working with 53Tidelift to deliver commercial support and maintenance for the open source 54dependencies you use to build your applications. Save time, reduce risk, and 55improve code health, while paying the maintainers of the exact dependencies you 56use. 57[Learn more.](https://tidelift.com/subscription/pkg/npm-entities?utm_source=npm-entities&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) 58