hyperstream

stream html into html at a css selector

  • Owner: substack/hyperstream
  • Platform:
  • License:: Other
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

hyperstream

stream html into html at a css selector

build status

example

var hyperstream = require('hyperstream');
var fs = require('fs');

var hs = hyperstream({
    '#a': fs.createReadStream(__dirname + '/a.html'),
    '#b': fs.createReadStream(__dirname + '/b.html')
});
var rs = fs.createReadStream(__dirname + '/index.html');
rs.pipe(hs).pipe(process.stdout);
$ node example/hs.js
<html>
  <body>
    <div id="a"><h1>a!!!</h1></div>
    <div id="b"><b>bbbbbbbbbbbbbbbbbbbbbb</b></div>
  </body>
</html>

methods

var hyperstream = require('hyperstream')

var hs = hyperstream(streamMap)

Return a duplex stream that takes an html stream as input and produces an html
stream as output, inserting the streams given by streamMap at the css selector
keys.

If streamMap values are strings or functions, update the contents at the css
selector key with their contents directly without using a stream.

If streamMap values are non-stream objects, iterate over the keys and set
attributes for each key.

These attributes are special. Each attribute can be a string, buffer, or stream:

  • _html - set the inner content as raw html
  • _text - set the inner content as text encoded as html entities
  • _append, _appendText - add text to the end of the inner content encoded as
    html entities
  • _appendHtml - add raw html to the end of the inner content
  • _prepend, _prependText - add text to the beginning of the inner content
    encoded as html entities
  • _prependHtml - add raw html to the beginning of the inner context

For example, to set raw html into the inner content with the _html attribute,
do:

hyperstream({
    '#content': {
        _html: stream,
        'data-start': 'cats!',
        'data-end': 'cats!\ufff'
    }
})

You can also specify string operations for properties with an object instead of
a string. The object can have these properties:

  • append
  • prepend

Object properties are particularly handy for adding classes:

hyperstream({
    '.row': {
        class: { append: ' active' }
    }
})

which turns:

<div class="row"><b>woo</b></div>

into:

<div class="row active"><b>woo</b></div>

hs.select(), hs.update(), hs.replace(), hs.remove()

Proxy through methods to the underlying
trumpet instance.

install

With npm do:

npm install hyperstream

license

MIT

Main metrics

Overview
Name With Ownersubstack/hyperstream
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 1)
Platform
License:Other
所有者活动
Created At2013-01-02 02:43:05
Pushed At2016-02-26 16:05:50
Last Commit At2014-11-19 13:57:08
Release Count17
Last Release Name1.2.2 (Posted on 2014-11-19 13:57:08)
First Release Name0.0.0 (Posted on 2013-01-01 18:47:09)
用户参与
Stargazers Count185
Watchers Count11
Fork Count10
Commits Count96
Has Issues Enabled
Issues Count4
Issue Open Count2
Pull Requests Count3
Pull Requests Open Count2
Pull Requests Close Count4
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private