twit-thread
v2.1.0
Published
This module allows you to tweet as a thread using Twit wrapper API. If any of the strings passed to the function tweetThread is greater than max characters allowed per tweet by twitter (280 at the moment), the function will truncate those and proceed maki
Downloads
2
Maintainers
Readme
Table of Contents
About The Project
This module allows you to tweet as a thread using Twit wrapper. If any of the strings passed to the function tweetThread is greater than max characters allowed per tweet by twitter (280 at the moment), the function will truncate those and proceed making an ordered thread from those.
Built With
Installation
# with yarn
yarn add twit-thread
# or with npm
npm install twit-thread
Usage
const { TwitThread } = require("twit-thread");
// or import { TwitThread } from "twit-thread" in Typescript
const config = {
consumer_key: '...',
consumer_secret: '...',
access_token: '...',
access_token_secret: '...',
timeout_ms: 60*1000, // optional HTTP request timeout to apply to all requests.
strictSSL: true, // optional - requires SSL certificates to be valid.
};
}
async function tweetThread() {
const t = new TwitThread(config);
await t.tweetThread([{text: "hey 1/3"}, {text: "this is a thread 2/3"}, {text: "bye 3/3"}]);
}
tweetThread();
Will produce the following :
You can also pass additional options to each tweets in order to post some media attached to the tweets etc...
Example:
const { TwitThread } = require("twit-thread");
const fs = require("fs");
async function tweetThreadWithImage() {
const t = new TwitThread(config);
await t.tweetThread([
{
text: "hey 1/3",
options: { media_data: fs.readFileSync("./screenshot.png") },
},
{ text: "this is a thread 2/3" },
{ text: "bye 3/3" },
]);
}
tweetThreadWithImage();
Tests
Tests are run using jest, you can type :
yarn test
Some tests needs real twitter developer credentials and thus you must provide them through env variables as follow :
TEST_consumer_key=xxxx
TEST_consumer_secret=xxxx
TEST_access_token=xxxx
TEST_access_token_secret=xxxx
You can add a .env file at the root of the folder as we're using dotenv module
/!\Be aware that those precise tests will produce tweets and therefore might pollute the twitter account you've setup.
Contributing
Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Run the tests !
- Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.