Webshot provides a simple API for taking webpage screenshots. The module is a light wrapper around PhantomJS, which utilizes WebKit to perform the page rendering.
A simple url example:
var webshot = require('webshot');
webshot('google.com', 'google.png', function(err) {
// screenshot now saved to google.png
});An html example:
var webshot = require('webshot');
webshot('<html><body>Hello World</body></html>', 'hello_world.png', {siteType:'html'}, function(err) {
// screenshot now saved to hello_world.png
});Alternately, the screenshot can be streamed back to the caller:
var webshot = require('webshot');
webshot('google.com', function(err, renderStream) {
var file = fs.createWriteStream('google.png', {encoding: 'binary'});
renderStream.on('data', function(data) {
file.write(data.toString('binary'), 'binary');
});
});An example showing how to take a screenshot of a site's mobile version:
var webshot = require('webshot');
var options = {
screenSize: {
width: 320
, height: 480
}
, shotSize: {
width: 320
, height: 'all'
}
, userAgent: 'Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_2 like Mac OS X; en-us)'
+ ' AppleWebKit/531.21.20 (KHTML, like Gecko) Mobile/7B298g'
}
webshot('flickr.com', 'flickr.jpeg', options, function(err) {
// screenshot now saved to flickr.jpeg
});An optional options object can be passed as the third parameter in a call to webshot.
<tr>
<th>streamType</th>
<td>'png'</td>
<td>If streaming is used, this designates the file format of the streamed rendering. Possible values are
'png', 'jpg', and 'jpeg'.
</td>
</tr>
<tr>
<th>siteType</th>
<td>'url'</td>
<td>siteType indicates whether the content needs to be requested ('url') or is being provided ('html'). Possible values are
'url' and 'html'.
</td>
</tr>
<tr>
<th>renderDelay</th>
<td>0</td>
<td>Number of milliseconds to wait after a page loads before taking the screenshot.
</td>
</tr>
<tr>
<th>timeout</th>
<td>0</td>
<td>Number of milliseconds to wait before killing the phantomjs process and assuming webshotting has failed.
(0 is no timeout.)
</td>
</tr>
<tr>
<th>takeShotOnCallback</th>
<td>false</td>
<td>Wait for the web page to signal to webshot when to take the photo using <code>window.callPhantom('takeShot');</code>
</td>
</tr>
| Option | Default Value | Description |
|---|---|---|
| windowSize |
{ width: 1024
, height: 768 }
|
The dimensions of the browser window. screenSize is an alias for this property. |
| shotSize |
{ width: 'window'
, height: 'window' }
|
The area of the page document, starting at the upper left corner, to render.
Possible values are 'screen', 'all', and a number defining a pixel length.
'window' causes the length to be set to the length of the window (i.e. the shot displays what is initially visible within the browser window). 'all' causes the length to be set to the length of the document along the given dimension. |
| phantomPath | 'phantomjs' | The location of phantomjs. Webshot tries to use the binary provided by the phantomjs NPM module, and falls back to 'phantomjs' if the module isn't available. |
| phantomConfig | {} | Object with key value pairs corresponding to phantomjs command line options. |
| userAgent | undefined | The user-agent string Phantom sends to the requested page. If left unset, the default
Phantom user-agent will be used |
| script | undefined | An arbitrary function to be executed on the requested page. The script executes within the page's context and can be used to modify the page before a screenshot is taken. |
| paperSize | undefined | When generating a PDF, sets page.paperSize. Some options are documented here: ariya/phantomjs#15 Example: {format: 'A4', orientation: 'portrait'}
|
Tests are written with Mocha and can be run with npm test. The tests use
node-imagemagick and thus require that the
imagemagick CLI tools be installed.
(The MIT License)
Copyright (c) 2012 Brenden Kokoszka
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.