Socket
Socket
Sign inDemoInstall

chirp-stream

Package Overview
Dependencies
51
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    chirp-stream

twitter streaming apis in nodejs


Version published
Weekly downloads
4
increased by33.33%
Maintainers
1
Install size
4.76 MB
Created
Weekly downloads
 

Readme

Source

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

Keywords

FAQs

Last updated on 30 May 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc