## Usage

```js
var decode = require('{%= name %}');

console.log(decode('<div>abc</div>'));
//=> '<div>abc</div>'

// get the default entities directly
console.log(decode.chars);
```

## Characters

For performance, this library only handles the following common entities (split into groups for backward compatibility).

### Default entities

Only the following entities are converted by default.

| **Character** | **Description** | **Entity Name** | **Entity Number** |
| --- | --- | --- | --- |
| `<` | less than                          | `&lt;`    | `&#60;` |
| `>` | greater than                       | `&gt;`    | `&#62;` |
| `&` | ampersand                          | `&amp;`   | `&#38;` |
| `"` | double quotation mark              | `&quot;`  | `&#34;` |
| `'` | single quotation mark (apostrophe) | `&apos;`  | `&#39;` |


Get the default entities as an object:

```js
console.log(decode.chars);
```

### Extra entities

Only the following entities are converted when `'extras'` is passed as the second argument. 

| **Character** | **Description** | **Entity Name** | **Entity Number** |
| `¢` | cent                               | `&cent;`  | `&#162;` |
| `£` | pound                              | `&pound;` | `&#163;` |
| `¥` | yen                                | `&yen;`   | `&#165;` |
| `€` | euro                               | `&euro;`  | `&#8364;` |
| `©` | copyright                          | `&copy;`  | `&#169;` |
| `®` | registered trademark               | `&reg;`   | `&#174;` |

Example:

```js
// convert only the "extras" characters
decode(str, 'extras');
// get the object of `extras` characters
console.log(decode.extras);
```


### All entities

Convert both the defaults and extras:

```js
decode(str, 'all');
```

Get all entities as an object:

```js
console.log(decode.all);
```

## Alternatives

If you need a more robust implementation, try one of the following libraries:

- [html-entities][]
- [ent][]