chirp-stream

1.0.1 • Public • Published

chirp-stream Build Status

NPM version Dependency Status

Coverage Status Code Climate

twitter streaming apis in nodejs

Installation

npm i chirp-stream --save

Usage

var twitter = Chirp({
    consumer: {
        public: 'xxxxx',
        secret: 'xxxxx'
    },
    token: {
        public: 'xxxxx',
        secret: 'xxxxx'
    }
});
 
var userstream = twitter.stream('https://userstream.twitter.com/1.1/user.json');
 
userstream.on('data', function(data) {
    console.log(data);
});
 
userstream.on('json', function(json) {
    console.log(json);
});
 
userstream.on('end', function() {
    console.log('end');
});
 
userstream.on('error', function(error) {
    console.log(error);
});

Example

Public streams

statuses/filter

var filterstream = twitter.stream('https://stream.twitter.com/1.1/statuses/filter.json', {
    follow: 61260444 //me :)
});
//listen to events...

statuses/sample

var samplestream = twitter.stream('https://stream.twitter.com/1.1/statuses/sample.json');
//listen to events...

User streams

var userstream = twitter.stream('https://userstream.twitter.com/1.1/user.json');
//listen to events...

Option

  • consumer: Object Twitter app public and secret consumer.
  • token: Object Client public and secret token.

API

.stream()

create a stream

options

  • url: String Twitter endpoint
  • param: Object Twitter parameters optional
  • method: String default GET

return

streaming object

event

  • data: String twitter raw data. Beware: there are some incomplete data
  • json: Object twitter data Use this instead of data
  • response: Object response object
  • error: status code (404, 503, ...)
  • end

Readme

Keywords

Package Sidebar

Install

npm i chirp-stream

Weekly Downloads

1

Version

1.0.1

License

MIT

Last publish

Collaborators

  • ddo