Bird 

$3

$3

A repo with examples can be viewed here.

$3

Bird is just a wrapper around request. And request offers a stream interface and the standard Node callback interface. So Bird does this just as well.

Imagine an express route that returns a users home timeline as json. You can simply pipe the call to the response.

``js
// assuming you have the users oauth credentials
Bird.timelines.home({ oauth: oauth }).pipe(res)
`

$3

Uploading media is a 2-part process.

`js
var options = {
oauth: {
consumer_key: 'XXXXXXXXXXXXXXXXXX',
consumer_secret: 'XXXXXXXXXXXXXXX',
token: 'XXXXXXXXXXXXXXXXXX',
token_secret: 'XXXXXXXXXXXXXXXXX'
},
media: 'path/to/filename'
}

Bird.media.upload(options, function(err, httpResponse, body) {
if (err) throw err;

var options = {
oauth: {
consumer_key: 'XXXXXXXXXXXXXXXXXX',
consumer_secret: 'XXXXXXXXXXXXXXX',
token: 'XXXXXXXXXXXXXXXXXX',
token_secret: 'XXXXXXXXXXXXXXXXX'
},
status: 'hello world',
media_ids: JSON.parse(body).media_id_string
}
Bird.tweets.tweet(options, function(err, r, body){
if (err) throw err;
console.log('successfully tweeted media');
});
});
`

Routes

`
❯ node
> require('./index')
{ auth:
{ requestToken: ...,
accessToken: ... },
timelines:
{ home: ...,
mentions: ...,
user: ...,
retweetsOfMe: ... },
tweets:
{ retweets: ...,
show: ...,
oembed: ...,
retweeters: ...,
update: ...,
tweet: ...,
destroy: ...,
retweet: ...,
updateWithMedia: ... },
search: { tweets: ... },
messages:
{ index: ...,
sent: ...,
show: ...,
destroy: ...,
new: ... },
friends: { index: ..., list: ... },
friendships:
{ noRetweets: ...,
show: ...,
lookup: ...,
incoming: ...,
outgoing: ...,
create: ...,
destroy: ...,
update: ... },
followers: { index: ..., list: ... },
account:
{ settings: ...,
verify: ...,
banner: ...,
updateSettings: ...,
updateDeliveryDevice: ...,
updateProfile: ...,
updateProfileBackgroundImage: ...,
updateProfileColors: ...,
updateProfileImage: ...,
removeProfileBanner: ...,
updateProfileBanner: ... },
blocks:
{ list: ...,
index: ...,
create: ...,
destroy: ... },
users:
{ lookup: ...,
show: ...,
search: ...,
contributees: ...,
contributors: ...,
suggestionsWithSlug: ...,
suggestionsWithSlugMembers: ... },
favorites:
{ list: ...,
create: ...,
destroy: ... },
lists:
{ list: ...,
statuses: ...,
memberships: ...,
subscribers: ...,
showSubscribers: ...,
removeMember: ...,
createMember: ...,
removeSubscriber: ...,
createSubscriber: ... },
geo:
{ place: ...,
geocode: ...,
search: ...,
similarPlaces: ...,
createPlace: ... },
trends:
{ place: ...,
available: ...,
closest: ... },
spam: { report: ... },
help:
{ configuration: ...,
languages: ...,
privacy: ...,
tos: ... },
application: { rateLimits: ... } }
``

Author

|  |
|---|
| Aaron Ackerman |