pageres - npm Package Compare versions

Comparing version 6.2.4 to 6.3.0

dist/index.d.ts

 /// <reference types="node" />
+import type { BeforeScreenshot } from 'capture-website';
 import { EventEmitter } from 'events';
@@ -122,2 +123,29 @@ import captureWebsite = require('capture-website');
     readonly launchOptions?: captureWebsite.Options['launchOptions'];
+    /**
+    The specified function is called right before the screenshot is captured. It receives the Puppeteer [`Page` instance](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-page) as the first argument and the [`browser` instance](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-browser) as the second argument. This gives you a lot of power to do custom stuff. The function can be async.
+
+    Note: Make sure to not call `page.close()` or `browser.close()`.
+
+    @example
+    ```
+    const Pageres = require('pageres');
+
+    (async () => {
+        await new Pageres({
+            delay: 2,
+            beforeScreenshot: async (page, browser) => {
+                await checkSomething();
+                await page.click('#activate-button');
+                await page.waitForSelector('.finished');
+            }
+        })
+            .src('https://github.com/sindresorhus/pageres', ['480x320', '1024x768', 'iphone 5s'], {crop: true})
+            .dest(__dirname)
+            .run();
+
+        console.log('Finished generating screenshots!');
+    })();
+    ```
+    */
+    readonly beforeScreenShot?: BeforeScreenshot;
 }
@@ -124,0 +152,0 @@ /**

dist/index.js

@@ -211,3 +211,4 @@ "use strict";
             darkMode: options.darkMode,
-            launchOptions: options.launchOptions
+            launchOptions: options.launchOptions,
+            beforeScreenShot: options.beforeScreenShot
         };
@@ -214,0 +215,0 @@ if (options.username && options.password) {

package.json

 {
 	"name": "pageres",
-	"version": "6.2.4",
+	"version": "6.3.0",
 	"description": "Capture website screenshots",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -183,2 +183,30 @@ # ![pageres](media/promo.png)
 
+##### beforeScreenshot
+
+Type: `Function`
+
+The specified function is called right before the screenshot is captured, as well as before any bounding rectangle is calculated as part of `options.element`. It receives the Puppeteer [`Page` instance](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-page) as the first argument and the [`browser` instance](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-browser) as the second argument. This gives you a lot of power to do custom stuff. The function can be async.
+
+Note: Make sure to not call `page.close()` or `browser.close()`.
+
+```js
+const Pageres = require('pageres');
+
+(async () => {
+	await new Pageres({
+		delay: 2,
+		beforeScreenshot: async (page, browser) => {
+			await checkSomething();
+			await page.click('#activate-button');
+			await page.waitForSelector('.finished');
+		}
+	})
+		.src('https://github.com/sindresorhus/pageres', ['480x320', '1024x768', 'iphone 5s'], {crop: true})
+		.dest(__dirname)
+		.run();
+
+	console.log('Finished generating screenshots!');
+})();
+```
+
 ### pageres.src(url, sizes, options?)
@@ -185,0 +213,0 @@

No alert changes

Improved metrics

Total package byte prevSize

27282

increased by9.46%

Lines of code

468

increased by5.88%

Number of lines in readme file

264

increased by11.86%

No dependency changes