Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artskydj/tweet-tweet
:bird: A no-nonsense node module for posting tweets
https://github.com/artskydj/tweet-tweet
callback easy javascript js node posting-tweets simple tweet tweets twitter
Last synced: 25 days ago
JSON representation
:bird: A no-nonsense node module for posting tweets
- Host: GitHub
- URL: https://github.com/artskydj/tweet-tweet
- Owner: ArtskydJ
- Created: 2015-04-11T00:27:47.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-03-31T03:38:20.000Z (over 5 years ago)
- Last Synced: 2024-09-16T11:46:48.501Z (about 2 months ago)
- Topics: callback, easy, javascript, js, node, posting-tweets, simple, tweet, tweets, twitter
- Language: JavaScript
- Homepage: https://twitter.com/tweettweet_test
- Size: 18.6 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
tweet-tweet
=========
> A no-nonsense node module for posting tweets.
[](https://travis-ci.org/ArtskydJ/tweet-tweet)
This is *only* for updating your Twitter status. This does not get tweets, or stream search results. Images and videos are not supported.
# example
```js
var TweetTweet = require('tweet-tweet')
var tweet = TweetTweet({
consumerKey: '...',
consumerSecret: '...',
accessToken: '...',
accessTokenSecret: '...'
})
tweet('Never teach someone how to cartwheel beside a lake. #lessonlearned')
setTimeout(function () {
tweet('That awkward moment when you wake up... Said no one ever.')
}, 60 * 1000)
```
# api
```js
var TweetTweet = require('tweet-tweet')
```
## `TweetTweet(auth)`
If you don't know how to get the tokens and secrets from Twitter, see [AUTHENTICATION.md](https://github.com/ArtskydJ/tweet-tweet/blob/master/AUTHENTICATION.md) for detailed instructions.
- `auth` is an object with `consumerKey`, `consumerSecret`, `accessToken`, and `accessTokenSecret` properties
- Returns `tweet`
## `tweet(status, [cb])`
- `status` is a string or an object
- If it is a string, it is the text of your status update.
- If it is an object, it can have the parameters specified in the [Twitter API][twitter-update-status-api] under the *Parameters* section.
- `status` - **Required.** The text of your status update. E.g. `'i love my cat. #cats'`
- `in_reply_to_status_id` - The ID of an existing status that the update is in reply to. Note that the author must be referenced in the `status`.
- `possibly_sensitive` - If the tweet contains nudity, violence, etc. set this to `true`. Defaults to `false`.
- `cb(err, response)` is an optional callback function. If no callback is given, errors will be swallowed.
- `err` is an Error object or null.
- `response` is the parsed JSON response. See a sample response in the [Twitter API][twitter-update-status-api] under the *Example Result* section.
```js
// Status string vs. status object
tweet('i like Twitter')
// Equivalent
tweet({ status: 'i like Twitter' })
```
```js
// Setting parameters
tweet({
status: 'not for weak stomachs: http://emergency-room-pictures.com',
possibly_sensitive: true
})
```
```js
tweet({
in_reply_to_status_id: '579328173764014080',
// https://twitter.com/Twitter/status/579328173764014080
status: 'Happy birthday @twitter!'
// Since the status that is being replied to is from the @twitter
// account, then "@twitter" must be included in the status
})
```
```js
tweet('why is the sky blue?', function (err, res) {
if (err) throw err
console.log(res)
})
```
```js
tweet({
status: 'People comment "lol" even when they do not laugh.'
}, function (err, res) {
if (err) throw err
console.log(res)
})
```
# install
With [npm](http://nodejs.org/download) do:
npm install tweet-tweet
# license
[MIT](https://choosealicense.com/licenses/mit)
[twitter-update-status-api]: https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update