heroglyph v1.0.4

Heroglyph

Library providing utility methods to escape special characters to their HTML entities, decimal or hexadecimal as well as unescape their corresponding character references back to chars.

1. How it work

escape function will convert '#' to '#' or '#' or '#' depending on passed parameters.

unescape function will convert '#' or '#' or '#' to '#' this module supports 1029 characters the entities covered HTML5 and html 4.1

Installation

  npm install heroglyph --save
  yarn add --dev heroglyph

Usage

  var entity = require('heroglyph');

  var unescapeStr = 'item is under © ';
  var escapeStr = 'say $';

  var escapedString = entity.escape(escapeStr, 'entity');
  var unescapedString = entity.unescape(unescapeStr);

  console.log('Escaped: ' + escapedString);
  console.log('Unescaped: ' + unescapedString);

Parameter for escape()

entity will return & format
hex will return ( format
decimal will return % format

for a character witch have more than one entity

ex: for '↑' it has ↑ ↑ ↑ ↑ entities

use 1, 2, 3, 4, as parameter instead of entity and get alternative entity

var entity = require('heroglyph');

entity.escape('& here we are', 1); // will return ↑

/* the paramter must be a number not a string */