puppeteer-mass-screenshots - npm Package Compare versions

puppeteer-mass-screenshots

Package Overview

Dependencies

Maintainers

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 1.0.12 to 1.0.13

package.json

		{
		"name": "puppeteer-mass-screenshots",
		"version": "1.0.12",
		"version": "1.0.13",
		"description": "This package creates massive amount of screenshots automatically, using Chrome API screencast,",
		@@ -5,0 +5,0 @@ "main": "index.js",

132

README.md

		@@ -5,17 +5,32 @@ # puppeteer-mass-screenshots
		<p>
		Puppeteer mass screenshots is a simple Puppeteer's plugin to create screenshots automatically by Chrome for every new frame appears in the browser.
		Puppeteer mass screenshots is a simple Puppeteer's plugin to create automatic screenshots for every new frame appears in the browser.
		<p>

		<h2> Why </h2>
		<p>
		Unlike the regular <a href="https://pptr.dev/#?product=Puppeteer&version=v5.4.1&show=api-pagescreenshotoptions"> screenshots function</a> supplied by Puppeteer,
		our plugin runs on Chrome's API and doesn't affect Puppeteer's run time.
		</p>
		<p>So basically by using this plugin, you'll be able to create very fast screenshots, and it won't slow your run time </p>

		<a name="Prerequisites"></a>
		## Prerequisites
		In order to use this plugin, Puppeteer must be installed, and Pupepteer's page object must be created.
		<h2> Prerequisites </h2>
		<p>In order to use this plugin:</p>
		<p>
		<ul>
		<li>Puppeteer must be installed.</li>
		<li>Pupepteer's page object must be created.</li>
		</ul>
		</p>

		<a name="Installation"></a>
		## Installation
		To install the plugin to your project please use:
		```
		<h2>Installation</h2>
		<p>To install the plugin to your project please use:</p>

		```javascript
		npm install puppeteer-mass-screenshots
		```
		<p>
		You'll probably prefer to add it to your package.json file so you can use:</p>

		You'll probably prefer to add it to your package.json file so you can use:
		```
		@@ -26,51 +41,88 @@ npm install --save-prod puppeteer-mass-screenshots
		<a name="Manual"></a>
		## Manual
		### Example:
		<h2>Manual</h2>
		<p>
		Once Puppeteer mass screenshots is installed, you can require it in your project:

		```javascript
		// You'll probably want this code in some async init function
		const screenshotsPath = join(__dirname, 'images');
		const PuppeteerMassScreenshots = require('puppeteer-mass-screenshots');
		```
		</p>
		<p>
		In your constructor create:

		```javascript
		const screenshots = new PuppeteerMassScreenshots();
		```
		</p>

		<p>
		After you have page object

		```javascript
		await screenshots.init(page, screenshotsPath);
		```
		<ul>
		<li><b>page</b> - Puppeteer page object (related to the browser).</li>
		<li><b>screenshotsPath</b> - where to save the created images</li>
		</ul>
		</p>
		<p>
		To start the automatic screenshots:

		// Use the start function where you want to start taking screenshots
		```javascript
		await screenshots.start();
		```
		</p>

		// Do some things with the page
		// Maybe some automation code
		<p>
		To stop the automatic screenshots:

		await screenshots.stop(); // Do this before browser is closed

		```javascript
		await screenshots.stop();
		```
		<p>
		<b>Important</b> - call screenshots.stop before browser is closed.
		</p>

		### page
		the page object you already use with your Puppeteer run.

		### outputFolder
		a full path of an existing folder, to be used to save screenshots.

		### init options
		See our [Init options page](InitOptions.md "Puppeteer mass screenshots - init options")

		### start options
		See our [Start options page](StartOptions.md "Puppeteer mass screenshots - start options")

		<a name="FAQ"></a>
		## FAQ
		<h2> FAQ </h2>

		### Does it work when Chrome is in headless mode?
		Yes, it does, it supports Chrome in headless mode, and in headful mode.

		### Does it support redirections in pages?
		Yes, it does, this solution is based on Chrome's API,
		<h3> Does it support Chrome in headless mode?</h3>
		<p>
		Yes, it does.
		</p>
		<p>
		it supports Chrome in headless / headful mode.
		</p>
		<br/>
		<h3> Does it support redirections in pages? </h3>
		<p>Yes, it does.</p>
		<p>This plugin is based on Chrome's API, </p>
		<p>
		which isn't affected by page's redirections.
		</p>
		<br/>
		<h3> Does it use the window object? </h3>
		<p>No, it doesn't use the window object.</p>
		<br/>

		### Does it use the window object?
		No, it doesn't use the window object.
		<h3> Can I run this plugin with my own page/browser objects? </h3>
		<p>
		Yes.
		</p>
		<p>put the page object in the init function, and the plugin will use it.
		</p>
		<br/>

		### Can I run it with my own page/browser objects?
		Yes, put the page object in the init function, and we will use it.
		<h3> Will it change my browser/page/window objects? </h3>
		<p>No, it won't.</p>
		<p>We use Chrome's API only.</p>
		<br/>

		### Will it change my browser/page/window objects?
		No, it won't, we use Chrome's API only.
		<h2> Other options to configure [ optional ] </h2>
		<p> <b>init options</b> - see our <a href="InitOptions.md"> Init options page</a>
		</p>

		<p> <b>start options </b> - see our <a href="StartOptions.md"> Start options page</a>
		</p>

Improved metrics