saveScreenshot

Save a screenshot as a base64 encoded PNG with the current state of the browser. Be aware that some Selenium driver are taking screenshots of the whole document (e.g. phantomjs) and others only of the current viewport. If you want to always be sure that the screenshot has the size of the whole document, use WebdriverCSS to enhance this command with that functionality.

Usage

1
client.saveScreenshot([filename]).then(callback);

Parameters

Param Type Details
filename
optional
Function/String path to the generated image (relative to the execution directory)

Example

saveScreenshot.js
1
2
3
4
5
6
// receive screenshot as Buffer
client.saveScreenshot(function(err, screenshot, response) { ... });
// save screenshot to file and receive as Buffer
client.saveScreenshot('./snapshot.png', function(err, screenshot, response) { ... });
// save screenshot to file
client.saveScreenshot('./snapshot.png');

Uses