You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
74 lines
3.3 KiB
74 lines
3.3 KiB
# 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) |
|
|
|
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` perf | `encode` perf | `escape` perf | Bundle size | |
|
| -------------- | ------------- | ------------- | ------------- | -------------------------------------------------------------------------- | |
|
| entities | 1.418s | 6.786s | 2.196s | ![npm bundle size](https://img.shields.io/bundlephobia/min/entities) | |
|
| html-entities | 2.530s | 6.829s | 2.415s | ![npm bundle size](https://img.shields.io/bundlephobia/min/html-entities) | |
|
| he | 5.800s | 24.237s | 3.624s | ![npm bundle size](https://img.shields.io/bundlephobia/min/he) | |
|
| parse-entities | 9.660s | N/A | N/A | ![npm bundle size](https://img.shields.io/bundlephobia/min/parse-entities) | |
|
|
|
--- |
|
|
|
## Acknowledgements |
|
|
|
This libary wouldn't be possible without the work of these individuals. Thanks |
|
to |
|
|
|
- [@mathiasbynens](https://github.com/mathiasbynens) for his explanations |
|
about character encodings, and his library `he`, which was one of the |
|
inspirations for `entities` |
|
- [@inikulin](https://github.com/inikulin) for his work on optimized tries for |
|
decoding HTML entities for the `parse5` project |
|
- [@mdevils](https://github.com/mdevils) for taking on the challenge of |
|
producing a quick entity library with his `html-entities` library. |
|
`entities` would be quite a bit slower if there wasn't any competition. |
|
Right now `entities` is on top, but we'll see how long that lasts! |
|
|
|
--- |
|
|
|
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)
|
|
|