html-stream-extractor v1.0.0

html-stream-extractor

extract elements from a stream of html

About

This module uses htmlparser2 to parse streaming HTML, and cornet to perform selections.

Install

$ npm install --save html-stream-extractor

Usage

// Simple element selection

fs.createReadStream('index.html')
	.pipe(htmlStreamExtractor('article'))
	.pipe(myWritableStream());

    // myWritableStream will any article DOM nodes
    // found in index.html


// Multiple selectors with handlers, and options

var opts = {
    stream: {
        objectMode: false // since we're returning strings
    }
};
var selectors = {
    article: function (el) {
        var t = el.children[0].data;
        return t.charAt(t.length - 1);
    },
    header: function (el) {
        return el.attribs['class'];
    }
};

fs.createReadStream('index.html')
    .pipe(htmlStreamExtractor(selectors))
    .pipe(myWritableStream());

    // myWritableStream will receive the class name(s) of any
    // header elements, and the last letter of any articles found
    // in index.html

API

Constructor

htmlStreamExtractor([selector], [opts])

selector is a CSS selector string, or a map of selector string-handler function pairs. Make sure the return values are compatible with the objectMode setting, i.e. don't return strings without setting objectMode: false, as it is true by default. The handler functions will be passed a matched element as only argument. If no selector is provided, a pass-through stream will be created.

opts is a map containing two optional keys: stream and dom, whose values will be passed to the through2 and cornet constructors respectively.

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 using gulp.

Release History

1.0.0 remove cheerio, make objectMode: true by default 0.0.3 multiple selectors and handlers 0.0.2 added through2 options and object mode 0.0.1 first release

License

Copyright (c) 2014 Christofer Pak. Licensed under the MIT license.