Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

readme.md 2.2 KiB

3 år sedan
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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. Encode & decode XML and HTML entities with ease.
  3. ## How to…
  4. ### …install `entities`
  5. npm i entities
  6. ### …use `entities`
  7. ```javascript
  8. const entities = require("entities");
  9. //encoding
  10. entities.escape("&"); // "&"
  11. entities.encodeXML("&"); // "&"
  12. entities.encodeHTML("&"); // "&"
  13. //decoding
  14. entities.decodeXML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
  15. entities.decodeHTML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
  16. ```
  17. ## Performance
  18. This is how `entities` compares to other libraries on a very basic benchmark (see `scripts/benchmark.ts`, for 10,000,000 iterations):
  19. | Library | `decode` performance | `encode` performance |
  20. | -------------- | -------------------- | -------------------- |
  21. | entities | 10.809s | 17.683s |
  22. | html-entities | 14.029s | 22.670s |
  23. | he | 16.163s | 44.010s |
  24. | parse-entities | 28.507s | N/A |
  25. ---
  26. License: BSD-2-Clause
  27. ## Security contact information
  28. To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
  29. Tidelift will coordinate the fix and disclosure.
  30. ## `entities` for enterprise
  31. Available as part of the Tidelift Subscription
  32. 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)