# speedometer

> simple speed measurement in javascript

Latest version **1.1.0** (published 2018-06-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install speedometer
pnpm add speedometer
yarn add speedometer
bun add speedometer
```

## Health

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

Positive: has types package; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-06-18 |
| First published | 2013-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/speedometer) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 91 |
| Author | Mathias Buus Madsen |
| Maintainers | mafintosh |
| Keywords | speed, bytes, per, second, transfer |

## Links

- npm: https://www.npmjs.com/package/speedometer
- Repository: https://github.com/mafintosh/speedometer
- Homepage: https://github.com/mafintosh/speedometer#readme
- Issues: https://github.com/mafintosh/speedometer/issues
- npm.io page: https://npm.io/package/speedometer

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.0 (latest) — 2018-06-18
- 1.0.0 — 2015-10-16
- 0.1.4 — 2014-12-24
- 0.1.3 — 2014-06-30
- 0.1.2 — 2013-07-20
- 0.1.1 — 2013-04-16
- 0.1.0 — 2013-03-20

## README

# speedometer

Speed measurement in Javascript

```
npm install speedometer
```

## Usage

``` js
var speedometer = require('speedometer')
var fs = require('fs')

// Let's measure how fast we can read from /dev/urandom
var speed = speedometer()
var stream = fs.createReadStream('/dev/urandom')

stream.on('data', function(data) {
  // Simply call speed with the amount of bytes transferred
  var bytesPerSecond = speed(data.length)

  console.log(bytesPerSecond+' bytes/second')
})
```

You can always get the current speed by calling `speed()`.

Per default `speedometer` uses a 5 second buffer.
To change this simply pass another value to the constructor

``` js
var speed = speedometer(20) // uses a 20s buffer instead
```

## License

MIT

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