1
0
Fork 0
management/front/dkha-web-sz-main/node_modules/entities/readme.md

58 lines
2.6 KiB
Markdown
Raw Normal View History

2024-01-16 21:26:16 +08:00
# 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)
2023-12-18 13:12:25 +08:00
2024-01-16 21:26:16 +08:00
Encode & decode HTML & XML entities with ease & speed.
2023-12-18 13:12:25 +08:00
## How to…
### …install `entities`
2024-01-16 21:26:16 +08:00
npm install entities
2023-12-18 13:12:25 +08:00
### …use `entities`
```javascript
2024-01-16 21:26:16 +08:00
const entities = require("entities");
2023-12-18 13:12:25 +08:00
//encoding
2024-01-16 21:26:16 +08:00
entities.escape("&"); // "&"
entities.encodeXML("&"); // "&"
2023-12-18 13:12:25 +08:00
entities.encodeHTML("&"); // "&"
2024-01-16 21:26:16 +08:00
2023-12-18 13:12:25 +08:00
//decoding
2024-01-16 21:26:16 +08:00
entities.decodeXML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
2023-12-18 13:12:25 +08:00
entities.decodeHTML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
```
2024-01-16 21:26:16 +08:00
## 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 | ![npm bundle size](https://img.shields.io/bundlephobia/min/entities) |
| html-entities | 14.029s | 22.670s | ![npm bundle size](https://img.shields.io/bundlephobia/min/html-entities) |
| he | 16.163s | 44.010s | ![npm bundle size](https://img.shields.io/bundlephobia/min/he) |
| parse-entities | 28.507s | N/A | ![npm bundle size](https://img.shields.io/bundlephobia/min/parse-entities) |
2023-12-18 13:12:25 +08:00
---
License: BSD-2-Clause
2024-01-16 21:26:16 +08:00
## 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)