twitint

    0.0.4 • Public • Published

    twitint

    A fault tolerant app that listens to filtered tweets via the twitter streaming api and processes them according to a custom lambda function. The lambda function may be synchronous or asynchronous.

    Build Status Coverage Status Known Vulnerabilities

    Installation

    npm install twitter-lite
    npm install twitint
    

    Usage

    Starting A New Listener

    const Client = require('twitter-lite')
    const Listener = require('twitint')
     
     
    const client_primary = new Client({
      consumer_key: 'consumer_key',
      consumer_secret: 'consumer_secret',
      access_token_key: 'access_token_key',
      access_token_secret: 'access_token_secret'
    })
     
    const client_secondary = new Client({
      consumer_key: 'consumer_key',
      consumer_secret: 'consumer_secret',
      access_token_key: 'access_token_key',
      access_token_secret: 'access_token_secret'
    })
     
    // instantiate a new Listener using 2 clients with the secondary client acting as a fallback
    const listener = new Listener([client_primary, client_secondary])
     
    // starting a stream of tweets filtered by tracking terms
    listener.stream('statuses/filter', { track: 'javascript, nodejs, maldives, twitter, and, so, on' }, tweet => {
      // do stuff with tweets as they come
      console.log(tweet.id)
    })
     
    // the app emits a listening event when the active client has started streaming
    listener.on('listening', message => {
      console.log(message)
    })
     
    // the app emits an error only when all reconnect attempts have failed, thereby suspending all listeners
    listener.on('error', err => {
      console.log(err)
    })
     
    // the app warns of errors in processing individual tweets and emits a warning whenever the active client connection is interrupted
    listener.on('warning', message => {
      console.log(message)
    })

    Updating an Existing Listener

    This library allows you to apply updates to the initial listener without severing the connection between your app and twitter. It does this by starting a connection with the updated parameters using the fallback client and only then terminating the primary client. The application shouldn't theoretically lose any data between the switchover since one client remains open while the other is connecting.

    // update an existing listener
    listener.update('statuses/filter', { track: 'new terms, like, bubble gum, facebook, instagram, #10YearChallenge' }, tweet => {
      // do new stuff with tweets
      console.log(tweet.user)
    })

    Additional Events

    // the retrying event is emitted when attempting to reconnect
    listener.on('retrying', message => {
      console.log(message)
    })
     
    // the updating event is emitted when attempting to update an existing listener
    listener.on('updating', message => {
      console.log(message)
    })

    Install

    npm i twitint

    DownloadsWeekly Downloads

    1

    Version

    0.0.4

    License

    MIT

    Unpacked Size

    13.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • umran