Htmllaundry NPM

htmllaundry

A simple utility node module providing methods to handle html data. Inspired by the htmllaundry python package with the same name.

Installation

  npm install htmllaundry --save

Usage

Available methods:

escape: Convert HTML reserved characters to their corresponding HTML Entities.
unescape: Inverse operation of escape method.
stripMarkup: Strip all markup from a HTML fragment.

ES6 Examples

  import HL from 'htmllaundry';

Escaping special reserved HTML characters

 
  const string = "Foo & Bar";
  const escaped = HL.escape(string);

  console.log('string', string, 'escaped', escaped);
  // Input: Foo & Bar
  // Output: Foo &amp; Bar

Unescaping HTML entities to reserved HTML characters

  const string = "Foo &amp; Bar";
  const unescaped = HL.unescape(string);

  console.log('string', string, 'unescaped', unescaped);
  // Input: Foo &amp; Bar
  // Output: Foo & Bar

Stripping HTML tags

  const markup = "<html>Foo</html>";
  const text = HL.stripMarkup(markup);

  console.log('markup', markup, 'text', text);
  // Input: <html>Foo</html>
  // Output: Foo

ES5 Example

  var HL = require("htmllaundry");

  var markup = "<html><span>Foo</span><span>Bar</span></html>";
  var text = HL.stripMarkup(markup);

  console.log('markup', markup, 'text', text);
  // Input: <html><span>Foo</span><span>Bar</span></html>
  // Output: FooBar

Tests

   npm test

Test Status:

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.