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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
# parse-entities [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status]
Parse HTML character references: fast, spec-compliant, positional
information.
## Installation
[npm][]:
```bash
npm install parse-entities
```
## Usage
```js
var decode = require('parse-entities');
decode('alpha & bravo');
//=> alpha & bravo
decode('charlie ©cat; delta');
//=> charlie ©cat; delta
decode('echo © foxtrot ≠ golf 𝌆 hotel');
//=> echo © foxtrot ≠ golf 𝌆 hotel
```
## API
## `parseEntities(value[, options])`
###### `options`
* `additional` (`string`, optional, default: `''`)
— Additional character to accept when following an ampersand (without
error)
* `attribute` (`boolean`, optional, default: `false`)
— Whether to parse `value` as an attribute value
* `nonTerminated` (`boolean`, default: `true`)
— Whether to allow non-terminated entities, such as `©cat` to
`©cat`. This behaviour is spec-compliant but can lead to unexpected
results
* `warning` ([`Function`][warning], optional)
— Error handler
* `text` ([`Function`][text], optional)
— Text handler
* `reference` ([`Function`][reference],
optional) — Reference handler
* `warningContext` (`'*'`, optional)
— Context used when invoking `warning`
* `textContext` (`'*'`, optional)
— Context used when invoking `text`
* `referenceContext` (`'*'`, optional)
— Context used when invoking `reference`
* `position` (`Location` or `Position`, optional)
— Starting `position` of `value`, useful when dealing with values
nested in some sort of syntax tree. The default is:
```json
{
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"indent": []
}
```
###### Returns
`string` — Decoded `value`.
### `function warning(reason, position, code)`
Error handler.
###### Context
`this` refers to `warningContext` when given to `parseEntities`.
###### Parameters
* `reason` (`string`)
— Reason (human-readable) for triggering a parse error
* `position` (`Position`)
— Place at which the parse error occurred
* `code` (`number`)
— Identifier of reason for triggering a parse error
The following codes are used:
| Code | Example | Note |
| ---- | ------------------ | --------------------------------------------- |
| `1` | `foo & bar` | Missing semicolon (named) |
| `2` | `foo { bar` | Missing semicolon (numeric) |
| `3` | `Foo &bar baz` | Ampersand did not start a reference |
| `4` | `Foo &#` | Empty reference |
| `5` | `Foo &bar; baz` | Unknown entity |
| `6` | `Foo € baz` | [Disallowed reference][invalid] |
| `7` | `Foo � baz` | Prohibited: outside permissible unicode range |
###### `function text(value, location)`
Text handler.
###### Context
`this` refers to `textContext` when given to `parseEntities`.
###### Parameters
* `value` (`string`) — String of content
* `location` (`Location`) — Location at which `value` starts and ends
### `function reference(value, location, source)`
Character reference handler.
###### Context
`this` refers to `referenceContext` when given to `parseEntities`.
###### Parameters
* `value` (`string`) — Encoded character reference
* `location` (`Location`) — Location at which `value` starts and ends
* `source` (`Location`) — Source of character reference
## License
[MIT][license] © [Titus Wormer][author]
<!-- Definitions -->
[build-badge]: https://img.shields.io/travis/wooorm/parse-entities.svg
[build-status]: https://travis-ci.org/wooorm/parse-entities
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/parse-entities.svg
[coverage-status]: https://codecov.io/github/wooorm/parse-entities
[npm]: https://docs.npmjs.com/cli/install
[license]: LICENSE
[author]: http://wooorm.com
[warning]: #function-warningreason-position-code
[text]: #function-textvalue-location
[reference]: #function-referencevalue-location-source
[invalid]: https://github.com/wooorm/character-reference-invalid
|
