Skip to content

About

Node.js Twitter user stream module.

Resources

Stars

157 stars

Watchers

11 watching

Forks

Latest commit

 

History

28 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

user-stream

NPM module

Simple Node.js Twitter (API 1.1) user stream client (https://dev.twitter.com/docs/streaming-apis/streams/user)

NPM

Install

npm install user-stream

Usage

var Stream = require('user-stream');
var stream = new Stream({
    consumer_key: '',
    consumer_secret: '',
    access_token_key: '',
    access_token_secret: ''
});

//create stream
stream.stream();

//listen stream data
stream.on('data', function(json) {
  console.log(json);
});

Events

  • data - stream data in JSON format
  • garbage - stream data who can't be parsed to JSON
  • close - stream close event (stream connection closed)
  • error - error event (request error, response error, response status code greater than 200)
  • connected - stream created
  • heartbeat - twitter emitted heartbeat

Methods

  • stream - create stream connection
  • destroy - destroy/close stream connection

Streaming API request parameters link

var params = {
    with: 'user'
}
//create stream
stream.stream(params);

Reserved parameters for lib

  • delimited
  • stall_warnings

About

Node.js Twitter user stream module.

Resources

Stars

157 stars

Watchers

11 watching

Forks

Releases

Packages

Used by

Contributors

Languages