take-screenshots
v0.2.0
Published
Take clean website screenshots, without any popups and cookie blockers
Downloads
10
Readme
📸 take-screenshots
take-screenshots is a small NodeJS library than can take clean website screenshots, without any popups or cookie consent dialogs that may appear when browsing pages.
It uses Puppeteer with a set of optimal settings for loading pages & cleaning unwanted sections (any contributions for this are welcome).
Highlights
- Beautiful screenshots.
- Zero-config, but configurable when needed.
- Uses custom instance of Puppeteer if needed.
Getting Started
Installation
To use in your project, run:
npm i puppeteer take-screenshots
Note:
take-screenshots
requires Puppeteer to be installed in your project. It is a peer dependency so that the correct version or build is used on your platform.
Usage
The library has a simple API.
Example - Take a screenshot of twitter.com and save it as twitter.png
:
const takeScreenshot = require('take-screenshots');
(async () => {
await takeScreenshot('https://twitter.com', 'twitter.png');
await takeScreenshot.closeBrowser();
})();
Main function returns the image buffer, which you can manipulate or send forwards as a HTTP Response Example - Take a screenshot of nyt.com and process the image:
const takeScreenshot = require('take-screenshots');
(async () => {
let img = await takeScreenshot('https://twitter.com', {viewport: {width: 800, height: 600}});
// process the image, img is the image buffer
// sharp(img)
// if using Express, image can be sent as response
// res.send(img)
await takeScreenshot.closeBrowser();
})();
More
Please report any issues here on GitHub. Any contributions are welcome
License
Copyright (c) Andrei Igna