readme.md
1.16 KB
En- & decoder for XML/HTML entities.
####Features:
- Focussed on speed
- Supports three levels of entities: XML, HTML4 & HTML5
- Supports char code entities (eg.
U
)
- Supports char code entities (eg.
##How to…
###…install entities
npm i entities
###…use entities
//encoding
require("entities").encode(<str> data[, <int> level]);
//decoding
require("entities").decode(<str> data[, <int> level]);
The level
attribute indicates what level of entities should be decoded (0 = XML, 1 = HTML4 and 2 = HTML5). The default is 0 (read: XML).
There are also methods to access the level directly. Just append the name of the level to the action and you're ready to go (e.g. encodeHTML4(data)
, decodeXML(data)
).
License: BSD-like