tweet-stream
v1.1.0
Published
Create a readable object stream of tweets from the Twitter REST API via Twit
Downloads
3
Readme
tweet-stream
Create a readable object stream of tweets from the Twitter REST API via twit.
Installation
$ npm install tweet-stream
Overview
The point of this module is to provide a readable Stream
instance that spits
out tweet objects directly from the REST API, that traverses the entire result
via paging with the max_id
parameter.
This can be used to backfill tweets for a specific user or search term.
Note that this will make requests as fast as possible, so watch out for rate limiting.
Usage
import Twit from 'twit';
import TweetStream from 'tweet-stream';
import through from 'through';
// Create an API instance with Twit
var twit = new Twit({
consumer_key : '...',
consumer_secret : '...',
access_token : '...',
access_token_secret : '...'
});
// Create the object stream of all tweets for this response
var stream = new TweetStream(twit, 'statuses/user_timeline', {
screen_name: 'bvalosek',
include_rts: false,
exclude_replies: true
});
// Dump to console
stream.pipe(through(data => console.log(data)));
In ES5-only Environments
If not using in an environment that supports ES6+, an ES5 build is available:
var TweetStream = require('tweet-stream/es5');
...
Testing
Maybe someday.
License
MIT