Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

parse and transform streaming html using css selectors

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.markdown

trumpet

Parse and transform streaming html using css selectors.

build status

trumpet

example

select

var trumpet = require('trumpet');
var tr = trumpet();

tr.select('.b span', function (node) {
    node.html(function (html) {
        console.log(node.name + ': ' + html);
    });
});

var fs = require('fs');
fs.createReadStream(__dirname + '/select.html').pipe(tr);
<html>
  <head>
    <title>beep</title>
  </head>
  <body>
    <div class="a">¡¡¡</div>
    <div class="b">
      <span>tacos</span>
      <span>y</span>
      <span>burritos</span>
    </div>
    <div class="a">!!!</div>
  </body>
</html>

output:

$ node example/select.js 
span: tacos
span: y
span: burritos

update

var trumpet = require('trumpet');
var tr = trumpet();

tr.select('.b span', function (node) {
    node.update(function (html) {
        return html.toUpperCase();
    });
});

tr.select('.c', function (node) {
    node.update('---');
});

tr.select('.d', function (node) {
    node.remove();
});

var fs = require('fs');
tr.pipe(process.stdout, { end : false });
fs.createReadStream(__dirname + '/update.html').pipe(tr);
<html>
  <head>
    <title>beep</title>
  </head>
  <body>
    <div class="a">¡¡¡</div>
    <div class="b">
      <span>tacos</span>
      <span>y</span>
      <span>burritos</span>
    </div>
    <div class="a">!!!</div>

    <div class="c">
        <span>beep</span>
        <span>boop</span>
    </div>

    <div class="d">
        <span>x</span>
        <span>y</span>
    </div>
  </body>
</html>

output:

$ node example/update.js
<html>
  <head>
    <title>beep</title>
  </head>
  <body>
    <div class="a">¡¡¡</div>
    <div class="b">
      <span>TACOS</span>
      <span>Y</span>
      <span>BURRITOS</span>
    </div>
    <div class="a">!!!</div>

    <div class="c">---</div>


  </body>
</html>

methods

var trumpet = require('trumpet')

var tr = trumpet(opts)

Create a new trumpet stream. This stream is readable and writable. Pipe an html stream into tr and get back a transformed html stream.

By default, trumpet uses this list of self-closing tags:

[ 'area', 'base', 'basefont', 'br', 'col', 'hr', 'input', 'img', 'link', 'meta' ]

You can specify a custom list by setting opts.special.

tr.select(selector, fn)

Fire fn(node) for every element in the html stream that matches the css selector.

The nodes are described in the nodes section of this document.

nodes

node.name

The name of the html element node, such as 'div' or 'span'.

node.attributes

An object with all the html attributes.

For example,

<img src="/beep.png" width="32" height="32">

has an attribute object of:

{ src : 'beep.png', width : '32', height : '32' }

node.html(cb)

Get the inner text and html for the element, which may not have arrived yet.

cb(text) fires when the inner contents are ready.

node.update(cb)

Replace the node's inner contents with the string return value from cb(html).

node.update(html)

Replace the node's inner contents with a string html.

node.replace(cb)

Replace completely the node's inner context with the string return value from cb(html). The html will be the inner contents.

node.replace(html)

Replace completely the node's contents with a string html.

node.remove()

Remove a node completely from the output stream.

selector syntax

Presently these css selectors work:

  • *
  • E
  • E F
  • E > F
  • E + F
  • E.class
  • E#id

install

With npm do:

npm install trumpet

license

MIT/X11

Something went wrong with that request. Please try again.