npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

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

Readme

Build Issues MIT License Coverage Status

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 :

Twitter thread using Twit Thread

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.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Run the tests !
  5. Push to the Branch (git push origin feature/AmazingFeature)
  6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.