npm stats
  • Search
  • About
  • Repo
  • Sponsor
  • more
    • Search
    • About
    • Repo
    • Sponsor

Made by Antonio Ramirez

url2png

6.0.2

@forbeslindesay

npmHomeRepoSnykSocket
Downloads:11370
$ npm install url2png
DailyWeeklyMonthlyYearly
url2png =======

node.js library for url2png

Get your account at http://url2png.com/

Installation

$ npm install url2png

Usage

var url2png = require('url2png')('API_KEY', 'PRIVATE_KEY');

var screenshotUrl = url2png.buildURL(url, options);

var screenshotStream = url2png.readURL(url, options);

Params

Url

The target url as a string.

Options

Nametypedefaultdescription
viewportstring1280x1024The viewport for the browser. Max is 4000x4000
fullpagebooleanfalseCapture the entire page, even what is outside of the viewport.
thumbnail_max_widthpixels-Maximum width of image returned. If not specified image return will be 1:1.
delayseconds-EXTRA delay in seconds to handle flash animation.
You probably don't need this!
We work hard to detect the right time to take the screenshot.
forcebooleanfalseShall we use the cached version if it already exists?
protocolstring-The protocol to use, can be 'https' or 'http' (blank to use protocol relative urls).

Samples

var url2png = require('url2png')('API_KEY', 'PRIVATE_KEY');

var options = {
  viewport : '900x600',
  thumbnail_max_width : 400,
  protocol: 'http'
}

//Get the URL
var url = url2png.buildURL('google.com' options);

//...or download the image to a file
var fs = require('fs');
url2png.readURL('google.com' options).pipe(fs.createWriteStream('google.png'));

//...or send the image in the http response
var http = require('http');
http.createServer(function (req, res) {
  if (req.url === '/google.png') {
    url2png.readURL('google.com' options).pipe(res)
  }
});