pssg
v0.2.0
Published
Node client for Google Screenshot API
Downloads
10
Readme
pssg
Description
pssg:
- stands for "pagespeed screengrab".
- is a node client for Google's "secret" screenshot API
- helps you rapidly generate thumbnails, like Urlbox (but free and lower quality) or PhantomJS (but faster and lower quality)
Usage
First, install pssg:
npm install pssg --save-dev
Then call download
or base64
:
var pssg = require('pssg');
var filename = 'yeezy_screengrab';
pssg.download('http://www.kanyewest.com', {
dest: __dirname,
filename: filename
}).then(function(file) {
console.log('Saved to ' + file + '.');
});
pssg.base64('http://randallma.com')
.then(function(b64) {
console.log('Screenshot base64 snippet: ' + b64.substr(0, 20));
});
That's it!
API
pssg.download(url, opts)
Save a screengrab to disk. Returns a promise, from which you can get the final path to the image.
pssg.base64(url)
Fetch the screenshot but don't save it to disk. Returns a promise, from which you can get the base64 encoded image.
opts
dest - Only used with pssg.download
. String path to the desired directory in which to save the screengrab.
filename - Only used with pssg.download
. Desired filename for the screengrab. .jpg
extension will automatically be concatenated.
mobile - Boolean, defaults to false
. Set to true
to request mobile screengrab of page.
License
MIT