snapshot-stream
v2.2.2
Published
Capture screenshot of a website and return it as a stream
Downloads
33
Maintainers
Readme
screenshot-stream
Copy from screenshot-stream; Fix it's bug!
Capture screenshot of a website and return it as a stream
Install
$ npm install --save snapshot-stream
Usage
var fs = require('fs');
var screenshot = require('snapshot-stream');
var stream = screenshot('http://google.com', '1024x768', {crop: true});
stream.pipe(fs.createWriteStream('google.com-1024x768.png'));
API
snapshot(url, size, options)
url
Type: string
Add page to capture.
size
Type: string
Set viewport size.
options
Type: object
Define options to be used.
crop
Type: boolean
Default: false
Crop to the set height.
delay
Type: number
(seconds)
Default: 0
Delay capturing the screenshot. Useful when the site does things after load that you want to capture.
selector
Type: string
Capture a specific DOM element.
hide
Type: array
Hide an array of DOM elements.
headers
Type: object
Default: {}
Set custom headers.
cookies
Type: array
or object
A string with the same format as a browser cookie or an object of what phantomjs.addCookie
accepts.
username
Type: string
Username for authenticating with HTTP auth.
password
Type: string
Password for authenticating with HTTP auth.
format
Type: string
Default: png
Set format to render the image as. Supported formats are png
and jpg
.
scale
Type: number
Default: 1
Scale webpage n
times.
userAgent
Type: string
Set a custom user agent.
.on('error', callback)
Type: function
PhantomJS errors.
.on('warn', callback)
Type: function
Warnings with eg. page errors.
CLI
See the pageres CLI.
License
MIT © Kevin Mårtensson