twit-wrapper

1.0.5 • Public • Published

twit-wrapper

npm Travis (.org) npm bundle size

Highly opinionated Twitter API client for Node.js

This is a small heavily opinionated utility wrapper library around twit.
It is implemented with facade pattern which translates twit library's existing interface into simplified one.

Prerequisite

To interact with Twitter API, head over to Twitter Developer Platform and create new application.
Once you are done filling out information, you need to generate four access tokens:

  • Consumer API Key
  • Consumer API Secret Key
  • Access Token
  • Access Token Secret

Install

npm i twit-wrapper

Usage:

Only most commonly used function for interacting with Twitter API are implemented:

  • postTweet(msg)
  • getTweets(keyword, fromDate, lang = 'en', maxResults = 100)
const TwitterClient = require('twit-wrapper');
const twitterClient = new TwitterClient(
  consumerAPIKey,
  consumerAPISecretKey,
  accessToken,
  accessTokenSecret,
);
 
// post new tweet
try {
  const msgToPost = 'Post a test message';
  const postedMsg = await twitterClient.postTweet(msgToPost);
  console.log(postedMsg);
} catch (e) {
  console.error(e);
}
 
// search twitter for all tweets containing the word 'javascript' since January 1, 2017
try {
  const searchedTweets = await twitterClient.getTweets('javascript', '2017-01-01');
  console.log(searchedTweets);
} catch (e) {
  console.error(e);
}

Dependencies (1)

Dev Dependencies (18)

Package Sidebar

Install

npm i twit-wrapper

Weekly Downloads

1

Version

1.0.5

License

MIT

Unpacked Size

9.59 kB

Total Files

4

Last publish

Collaborators

  • marko424