topmark-scrollspeed v1.0.0

Scrollspeed

A Topmarks plugin to automate the testing of a website's scroll performance in chrome.

Installation

Install from npm npm.

npm install topmark-scrollspeed

Usage

Nodejs

const Topmarks = require('topmarks');

const options = {
  scrollspeed: { //This will pass these options to only this plugin, alternatively you can use default for all plugins
    port: 9222 //Chrome debugging port - defaults to 9222
    url: 'http://topcoat.io' //url to test, defaults to http://topcoat.io
  }
};

let topmarks = new Topmarks(options);
topmarks.register('topmark-scrollspeed').then((results) => {
  console.log(results);
}).catch((err) => {
  console.log(err);
});

CLI

If using the command line tool for Topmarks it needs to be installed globally, as well as any plugins.

npm install -g topmarks topmark-scrollspeed

$ topm --url http://topcoat.io --plugins topmark-scrollspeed

[ {
  "id":"topcoat",
  "plugin":"scrollspeed",
  "url":"http://topcoat.io",
  "timestamp":1468523571839,
  "report": {
    "averageFrameRate":42.41,
    "totalFrameCount":92,
    "totalLargeFrameCount":9,
    "frameBreakDown": {
      "idle":"97.84%",
      "other":"1.38%",
      "painting":"0.63%",
      "rendering":"0.08%",
      "scripting":"0.07%",
      "loading":"0%"
    }
  }
} ]

Sample Report

Should return a report similar to this:

[ {
  "id":"topcoat",
  "plugin":"scrollspeed",
  "url":"http://topcoat.io",
  "timestamp":1468523571839,
  "report": {
    "averageFrameRate":42.41,
    "totalFrameCount":92,
    "totalLargeFrameCount":9,
    "frameBreakDown": {
      "idle":"97.84%",
      "other":"1.38%",
      "painting":"0.63%",
      "rendering":"0.08%",
      "scripting":"0.07%",
      "loading":"0%"
    }
  }
} ]