# topmark-scrollspeed

> Topmarks plugin for checking scroll performance

Latest version **1.0.0** (published 2016-08-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install topmark-scrollspeed
pnpm add topmark-scrollspeed
yarn add topmark-scrollspeed
bun add topmark-scrollspeed
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-08-02 |
| First published | 2016-07-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Garth Braithwaite |
| Maintainers | garthdb |
| Keywords | topmarks-plugin, scrolling, performance, browser |

## Links

- npm: https://www.npmjs.com/package/topmark-scrollspeed
- Repository: https://github.com/Topmarks/topmark-scrollspeed
- Homepage: https://github.com/Topmarks/topmark-scrollspeed#readme
- Issues: https://github.com/Topmarks/topmark-scrollspeed/issues
- npm.io page: https://npm.io/package/topmark-scrollspeed

## Dependencies (2)

- [chrome-helper](https://npm.io/package/chrome-helper.md) ^0.2.0
- [devtools-timeline-model](https://npm.io/package/devtools-timeline-model.md) ^1.1.6

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-08-02
- 0.3.1 — 2016-08-02
- 0.3.0 — 2016-08-02
- 0.2.1 — 2016-07-24
- 0.2.0 — 2016-07-24
- 0.1.6 — 2016-07-18
- 0.1.5 — 2016-07-15
- 0.1.4 — 2016-07-15
- 0.1.3 — 2016-07-14
- 0.1.2 — 2016-07-14
- 0.1.1 — 2016-07-14
- 0.1.0 — 2016-07-14
- 0.0.2 — 2016-07-12
- 0.0.1 — 2016-07-12

## README

# Scrollspeed

[![Build Status](https://travis-ci.org/Topmarks/topmark-scrollspeed.svg?branch=master)](https://travis-ci.org/Topmarks/topmark-scrollspeed) [![Code Climate](https://codeclimate.com/github/Topmarks/topmark-scrollspeed/badges/gpa.svg)](https://codeclimate.com/github/Topmarks/topmark-scrollspeed) [![Test Coverage](https://codeclimate.com/github/Topmarks/topmark-scrollspeed/badges/coverage.svg)](https://codeclimate.com/github/Topmarks/topmark-scrollspeed/coverage) [![Issue Count](https://codeclimate.com/github/Topmarks/topmark-scrollspeed/badges/issue_count.svg)](https://codeclimate.com/github/Topmarks/topmark-scrollspeed) [![Dependency Status](https://david-dm.org/topmarks/topmark-scrollspeed.svg)](https://david-dm.org/topmarks/topmark-scrollspeed) [![Inline docs](http://inch-ci.org/github/Topmarks/topmark-scrollspeed.svg?branch=master)](http://inch-ci.org/github/Topmarks/topmark-scrollspeed) [![npm version](https://badge.fury.io/js/topmark-scrollspeed.svg)](https://badge.fury.io/js/topmark-scrollspeed)

A [Topmarks](http://github.com/topmarks/topmarks) plugin to automate the testing of a website's scroll performance in chrome.

## Installation

Install from npm [npm](https://docs.npmjs.com/getting-started/installing-node).

```sh
npm install topmark-scrollspeed
```

## Usage

### Nodejs

```js
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.

```sh
npm install -g topmarks topmark-scrollspeed
```

```sh
$ 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:

```js
[ {
  "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%"
    }
  }
} ]
```

---
_Source: https://npm.io/package/topmark-scrollspeed · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
