# topmark-loadspeed

> Topmarks plugin for checking page loadspeed

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

## Install

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

## 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.1 |
| Published | 2016-08-02 |
| First published | 2016-07-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Garth Braithwaite |
| Maintainers | garthdb |
| Keywords | topmarks-plugin, loading, performance, browser |

## Links

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

## Dependencies (1)

- [chrome-helper](https://npm.io/package/chrome-helper.md) ^1.0.0

## 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.1 (latest) — 2016-08-02
- 1.0.0 — 2016-08-02
- 0.4.2 — 2016-08-02
- 0.4.1 — 2016-08-02
- 0.3.0 — 2016-07-29
- 0.2.0 — 2016-07-23
- 0.1.5 — 2016-07-23
- 0.1.4 — 2016-07-18
- 0.1.3 — 2016-07-15
- 0.1.2 — 2016-07-15
- 0.1.1 — 2016-07-15
- 0.1.0 — 2016-07-14
- 0.0.3 — 2016-07-12
- 0.0.1 — 2016-07-12

## README

# Loadspeed

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

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

## Installation

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

```sh
npm install topmark-loadspeed
```

## Usage

### Nodejs

```js
const Topmarks = require('topmarks');

const options = {
  loadspeed: { //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-loadspeed').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-loadspeed
```

```sh
$ topm --url http://topcoat.io --plugins topmark-loadspeed

[ { plugin: 'loadspeed',
   url: 'http://topcoat.io',
   timestamp: 1468518500472,
   report: 0.2747849998995662 } ]
```

## Sample Report

Should return a report similar to this:

```js
[ { plugin: 'loadspeed',
    url: 'http://topcoat.io',
    timestamp: 1468518500472,
    report: 0.2747849998995662 } ]
```

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