.config/coc/extensions/node_modules/coc-prettier/node_modules/dom-serializer/node_modules/entities/readme.md

   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
   3 Encode & 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
  14 const entities = require("entities");
  15
  16 //encoding
  17 entities.escape("&#38;"); // "&#x26;#38;"
  18 entities.encodeXML("&#38;"); // "&amp;#38;"
  19 entities.encodeHTML("&#38;"); // "&amp;&num;38&semi;"
  20
  21 //decoding
  22 entities.decodeXML("asdf &amp; &#xFF; &#xFC; &apos;"); // "asdf & ÿ ü '"
  23 entities.decodeHTML("asdf &amp; &yuml; &uuml; &apos;"); // "asdf & ÿ ü '"
  24 ```
  25
  26 ## Performance
  27
  28 This 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 | Bundle size                                                                |
  31 | -------------- | -------------------- | -------------------- | -------------------------------------------------------------------------- |
  32 | entities       | 10.809s              | 17.683s              | ![npm bundle size](https://img.shields.io/bundlephobia/min/entities)       |
  33 | html-entities  | 14.029s              | 22.670s              | ![npm bundle size](https://img.shields.io/bundlephobia/min/html-entities)  |
  34 | he             | 16.163s              | 44.010s              | ![npm bundle size](https://img.shields.io/bundlephobia/min/he)             |
  35 | parse-entities | 28.507s              | N/A                  | ![npm bundle size](https://img.shields.io/bundlephobia/min/parse-entities) |
  36
  37 ---
  38
  39 License: BSD-2-Clause
  40
  41 ## Security contact information
  42
  43 To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
  44 Tidelift will coordinate the fix and disclosure.
  45
  46 ## `entities` for enterprise
  47
  48 Available as part of the Tidelift Subscription
  49
  50 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)