sebinsua / monitor-head-stream

💦 Monitor the head of a stream.

monitor-head-stream

💦 Monitor the head of a stream

This module polls streams of objects for their latest item(s).

It's sort of like tail -f for Streams, but acts upon the head of the stream.

It was created in order to help implement small-scale firehoses.

Other applications might include sending alerts via SMS or OSX notifications on breaking news or the mention of particular topics.

Example

import { TimelineStream } from 'scrape-twitter'
import JSONStream from 'JSONStream'
import pump from 'pump'

import monitorHeadStream from 'monitor-head-stream'

const createStream = () => new TimelineStream('POTUS')
const indexBy = obj => obj.id
const skipWhenPinned = obj => obj.isPinned === true

pump(
  monitorHeadStream(createStream, indexBy, skipWhenPinned),
  JSONStream.stringify('[\n', ',\n', '\n]\n'),
  process.stdout
)

Install

With yarn:

yarn add monitor-head-stream

With npm:

npm install --save monitor-head-stream

monitor-head-stream's Issues

monitorHeadStream is not a function

I'm getting this when I run the example, any idea?

onst createStream = () => new TimelineStream('POTUS')
const indexBy = obj => obj.id
const skipWhenPinned = obj => obj.isPinned === true

pump(
  monitorHeadStream(createStream, indexBy, skipWhenPinned),
  JSONStream.stringify('[\n', ',\n', '\n]\n'),
  process.stdout
)

 monitorHeadStream(createStream, indexBy, skipWhenPinned),
  ^

TypeError: monitorHeadStream is not a function
    at Object.<anonymous> (/Users/usw/code/test/liquidation.js:43:3)
    at Module._compile (module.js:571:32)
    at Object.Module._extensions..js (module.js:580:10)
    at Module.load (module.js:488:32)
    at tryModuleLoad (module.js:447:12)
    at Function.Module._load (module.js:439:3)
    at Module.runMain (module.js:605:10)
    at run (bootstrap_node.js:425:7)
    at startup (bootstrap_node.js:146:9)
    at bootstrap_node.js:540:3