entcoder
v1.0.0
Published
Fastest entities or ascii encode/decode Javascript library.
Downloads
4
Maintainers
Readme
Entcoder
Fastest entities or ascii encode/decode Javascript library.
npm install
$ npm install entcoder
<!-- Implement Entcoder library (recomended) HTML Head section -->
<script src="node_modules/webpack/entcoder.min.js"></script>
<!-- OR -->
<script src="https://cdn.jsdelivr.net/npm/entcoder/webpack/entcoder.min.js"></script>
Usage
encode(text, options)
Encodes text replacing HTML special characters (<>&"'
) and/or other character ranges depending on mode
option value.
For Simple Javascript
const {encode} = new Entcoder();
const {encode} = require("entcoder");
encode("< & >");
// Output: < & >
// set default encoding "entities" and type "html5"
encode("@package<name> ⨻", {encoding: "entities", type: "html5"});
// Output: @package<name> ⨻
encode("⨻ ∅ ▽", {encoding:"entities" type: "specialchar"});
// Output: ⨻ ∅ ▽
// Encode hexadecimal formate
encode("𝓎 ⎱ ⦾ ℜ ⦰ ⨌", {encoding: "hex", type: "allchar"});
// Output: 𝓎 ⎱ ⦾ ℜ ⦰ ⨌
// Encode decimal formate
encode("𝓎 ⎱ ⦾", {encoding: "dec", type: "allchar"});
// Output: 𝓎   ⎱   ⦾
Options:
encoding
entities
hex
dec
type
allchar
xml
html4
html5
specialchar
numeric
decimal
uses decimal numbers when encoding html entities. i.e.©
(default).hexadecimal
uses hexadecimal numbers when encoding html entities. i.e.©
.
decode(text, options)
Decodes text replacing entities to characters. Unknown entities are left as is.
const {decode} = require("entcoder");
decode("< & >");
// Output: < & >
// set default decoding "entities" and type "html5"
decode("@package<name> ⨻", {decoding: "entities", type: "html5"});
// Output: @package<name> ⨻
decode("⨻ ∅ ▽", {decoding:"entities" type: "specialchar"});
// Output: ⨻ ∅ ▽
// Decode hexadecimal formate
decode("𝓎 ⎱ ⦾ ℜ ⦰ ⨌", {decoding: "hex", type: "allchar"});
// Output: 𝓎 ⎱ ⦾ ℜ ⦰ ⨌
// Decode decimal formate
decode("𝓎   ⎱   ⦾", {decoding: "dec", type: "allchar"});
// Output: 𝓎 ⎱ ⦾
Options:
encoding
entities
hex
dec
type
allchar
xml
html4
html5
specialchar