lukehorvat / screenshot-tweet

Screenshot a tweet.
MIT License
68 stars 6 forks source link
image screenshot tweet twitter

screenshot-tweet NPM version

Screenshot a Twitter tweet.

Installation

Install the package with NPM:

$ npm install -g screenshot-tweet

The -g flag is recommended for easy CLI usage, but completely optional.

API

The package exposes a function with the signature (tweetUrl, filePath), where tweetUrl is the URL of the tweet and filePath is the filesystem location to save the screenshot at. Returns a Promise.

Example:

import screenshotTweet from "screenshot-tweet";

screenshotTweet(
  "https://twitter.com/reactjs/status/912712906407501825",
  "tweet.jpg"
).then(() => {
  console.log("Success");
}).catch(error => {
  console.error("Error");
});

If filePath is omitted, the Promise will resolve with a Buffer containing the screenshot data.

CLI

Execute screenshot-tweet from the command line with the following arguments:

$ screenshot-tweet TWEET_URL FILE_PATH

Example:

$ screenshot-tweet https://twitter.com/reactjs/status/912712906407501825 tweet.jpg