html-escaping v1.0.1

helper to escape special characters in a given string

Installation

$ npm install html-escaping

Examples

var html = require('html-escaping');
var escape = html.escape;
var unescape = html.unescape;

var htmlString = '<h1>Hello World</h1>';
var escaped = escape(htmlString);
var unescaped = unescape(escaped);

console.log('html', htmlString, 'escaped', escaped, 'unescaped', unescaped);

API

###escape(htmltring) escape special characters by replacing them with entity names ###unescape(htmlString) clean up entity names with special characters

Tests

To run the test suite, first install the dependencies, then run npm test:

$ npm install
$ npm test

License

(The MIT License)

Copyright (c) 2015 EagleWalker <StevenNguyen>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.