Giter VIP home page Giter VIP logo

node-domshot's Introduction

DOMShot

Installation

npm install domshot

Usage

var DOMShot = require('domshot');
var wd      = require('wd');
var browser = wd.remote('localhost', 5555);

browser.init({}, function () {

  var domshot = new DOMShot({
    browser : browser
  });

  domshot.get('https://github.com', function (err, results) {
    console.log(results);
    browser.quit();
  });

});

API

new DOMShot(options)

The constructor returns a new domshot instance. It uses the provided browser to navigate to the websites. The browser will not be altered in any other way and should be usable after domshot is finished.

options

If you don't specify an outputPath in the options object, no files will be created and you have to use the image buffers of the elements returned by the get method.

  • browser - object: wd browser instance
  • outputPath - string (optional): Base path where images will be stored. default: undefined
  • path - function (element, options) (optional): The result is appended to outputPath.
  • filename - function (element, options) (optional): The result is appended to outputPath after path(element, options).

domshot.get(options, callback)

options

  • url - string: The target URL
  • selectors - array (optional): CSS selectors of elements to be captured. default: ['body']

result

[
  {
    selector : ...,
    url      : ...,
    image    : ..., // image buffer
    filename : ..., // only present if outputPath is set
    filepath : ..., // only present if outputPath is set

    size : {
      width  : ...,
      height : ...
    },

    location : {
      x : 0,
      y : 0
    }
  },
  ...
]

domshot.get(url, callback)

Shorthand for domshot.get({ url : url }, callback)

domshot.get(optionsArray, callback)

Another shorthand. optionsArray contains multiple options objects suitable for domshot.get(options, callback).

node-domshot's People

Contributors

kvnloo avatar ksmth avatar

Stargazers

 avatar Chris Hart avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.