Code Monkey home page Code Monkey logo

twittxr's Introduction

twittxr's People

Contributors

owen3h avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

twittxr's Issues

feat: make using puppeteer optional.

Puppeteer is known to be annoying to work with, especially when running on platforms like Koyeb, Heroku, Netlify etc.
Instead, make puppeteer-extra an optional dependency and give clients a method like usePuppeteer().

Not using (default):

  • Directly calls Syndication API - same functionality as pre v0.6.0

If using:

  • Default browser will be headless: 'new'
  • Provide browser parameter that can be used instead.

feat: support creating a tweet feed.

Essentially, a feed would emit events depending on what happened.
Multiple objects can be passed to the feed so we can set options per user.

{
    username: string,
    proxyUrl?: string,
    cookie?: string
}

Events

"selfTweet"

Sent when the specified user(s) tweets. (Not a quote tweet)

{   
    timestamp: number,
    author: string,
    tweet: TimelineTweet
}

"retweet"

Sent when a retweet is detected by the specified users(s).

{
    timestamp: number,
    author: string,
    original: {
        author: string,
        tweet: TimelineTweet
    }
}

Example Usage

import { TweetFeed } from 'twittxr'

const feed = new TweetFeed({ 
  username: 'elonmusk' 
}, { 
  username: 'rileyreidx3', 
  cookie: process.env.TWITTER_COOKIE 
})

feed.on('selfTweet', event => {
  if (event.author === 'elonmusk') {
    console.log(event.tweet)
  }
})

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.