1.0 Proposal - Please read & comment!

1.0 Proposal

Twitter Lite is gaining traction and after learning how folks have been using it, here are changes I would make:

Breaking Changes

Turn all request arguments into keyword arguments:

before: async get (resource, parameters) async post (resource, body, parameters)

after: async get({ resource, params }) async post({ resource, body, params })

There won’t be any confusion in argument ordering.

Return results, response, error from requests

Currently we return just the results but there are rate limiting errors that are 200-level and don’t crash.

New API would look similar to:

return {
  results, // tweets, etc.
  response, // raw response object. You'd have to do your own `response.json()` here
  error // error object (if any)
}

Error handling

Right now twitter-lite forces the consumer to handle errors. We can take care of the errors ourselves. ** Would love to hear what folks think of this one **

Enhancements

Create makeRequest function that handles all requests under the hood. This will reduce code size.

• create a makeRequest function that handles:
  • get
  • post
  • stream

This will reduce bundle size and make handling errors / responses easier.

• add flowtype support Easier to debug errors

[peterpme]

How do ya’ll feel about making this a server-side only module for the time being? After reading a bunch about this, it seems like its a safer alternative than allowing requests to take place on the client

[tylerbuchea]

Although it will create an extra hurdle for contributors, having Typescript and Flow support will greatly increase the attraction from consumers of this library who use those technologies and it will have no negative effect for those who do not.

Since we are developing a library here I think valuing the consumers above the contributors (within reason) is always a smart move.