Extract data from the Twitter Application Programming Interface (API).

• Twitter Developer Documentation

If options.twitter.method == 'stream'

• Return a Twitter stream
• stream.on('data', function): calls function when a tweet is available
• stream.on('error', function): calls function when there is an error

Else

• Return a Promise object that resolves a data object in the form {twitter: {client: ..., tweets: ...}}

• data.twitter.client: contains a Twitter client object created from options.twitter.connection

• data.twitter.tweets: contains the tweets in JSON format

var twitter2return = require('twitter2return');

// (options) Initialize options object
var options = {twitter: {}};

// *** CONNECTION SETUP ***

// (options_twitter_connection) Twitter API connection keys
options.twitter.connection =  {
	consumer_key: '***', // process.env.TWITTER_CONSUMER_KEY
	consumer_secret: '***', // process.env.TWITTER_CONSUMER_SECRET
	access_token_key: '***', // process.env.TWITTER_ACCESS_TOKEN_KEY
	access_token_secret: '***' // process.env.TWITTER_ACCESS_TOKEN_SECRET
};

// *** SEARCH TWEETS ***

// (options_twitter_rest) Search for keyword 'twitter' in path 'GET search/tweets'
options.twitter.method = 'get'; // get, post, or stream
options.twitter.path = 'search/tweets'; // api path
options.twitter.params = {q: 'twitter'}; // query tweets

// (options_jsonata) Filter for statuses array using jsonata
options.jsonata = 'statuses';

// (twitter2return_rest) Query tweets using REST API
twitter2return(options)
	.then(data => {
		console.log(data);
	}).catch(err => {
		console.error(err.message);
	});

// *** STREAM TWEETS ***

// (options_twitter_connection) Track keyword 'twitter' in path 'POST statuses/filter'
options.twitter.method = 'stream'; // get, post, or stream
options.twitter.path = 'statuses/filter'; // api path
options.twitter.params = {track: 'twitter'}; // query tweets

// (options_jsonata) Remove jsonata filter
delete options.jsonata;

// (options_twitter_stream) Log the tweets when received
options.twitter.stream = function(err, data) {
	if (err) {console.error(err)};
	console.log(data.twitter.tweets);
};

// (twitter2return_stream) Stream tweets
var stream = twitter2return(options);
stream.on('error', function(error) {
	console.error(error.message);
});