.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / 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 En- & decoder for XML/HTML entities.
4
5 ## How to…
6
7 ### …install `entities`
8
9     npm i entities
10
11 ### …use `entities`
12
13 ```javascript
14 var entities = require("entities");
15 //encoding
16 entities.encodeXML("&");  // "&"
17 entities.encodeHTML("&"); // "&"
18 //decoding
19 entities.decodeXML("asdf & ÿ ü '");  // "asdf & ÿ ü '"
20 entities.decodeHTML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
21 ```
22
23 <!-- TODO extend API -->
24
25 ---
26
27 License: BSD-2-Clause