aboutsummaryrefslogtreecommitdiff
path: root/node_modules/entities/readme.md
blob: e660b4a5ed8be3f739435f8b337f6050a8dc457e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#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/node-entities.svg)](http://travis-ci.org/fb55/node-entities) [![Coverage](http://img.shields.io/coveralls/fb55/node-entities.svg)](https://coveralls.io/r/fb55/node-entities)

En- & decoder for XML/HTML entities.

##How to…

###…install `entities`

    npm i entities

###…use `entities`

```javascript
var entities = require("entities");
//encoding
entities.encodeXML("&");  // "&"
entities.encodeHTML("&"); // "&"
//decoding
entities.decodeXML("asdf & ÿ ü '");  // "asdf & ÿ ü '"
entities.decodeHTML("asdf & ÿ ü '"); // "asdf & ÿ ü '"
```

<!-- TODO extend API -->

---

License: BSD-like