# streamspeed

> Easily measure the speed of your streams.

Latest version **2.0.1** (published 2020-11-17) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2.0.1 |
| Published | 2020-11-17 |
| First published | 2012-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 17.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 43 |
| Author | fent |
| Maintainers | fent |
| Keywords | stream, speed |

## Links

- npm: https://www.npmjs.com/package/streamspeed
- Repository: https://github.com/fent/node-streamspeed
- Homepage: https://github.com/fent/node-streamspeed#readme
- Issues: https://github.com/fent/node-streamspeed/issues
- npm.io page: https://npm.io/package/streamspeed

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2020-11-17
- 2.0.0 — 2020-04-11
- 1.1.1 — 2018-04-06
- 1.1.0 — 2017-10-26
- 1.0.1 — 2017-08-10
- 1.0.0 — 2017-03-02
- 0.2.3 — 2016-12-05
- 0.2.2 — 2016-10-24
- 0.2.1 — 2015-09-27
- 0.2.0 — 2013-03-22
- 0.1.3 — 2012-01-23
- 0.1.2 — 2012-01-23
- 0.1.1 — 2012-01-23
- 0.1.0 — 2012-01-22

## README

# streamspeed

A simple way to keep track of the speed of your readable streams.

![Depfu](https://img.shields.io/depfu/fent/node-streamspeed)
[![codecov](https://codecov.io/gh/fent/node-streamspeed/branch/master/graph/badge.svg)](https://codecov.io/gh/fent/node-streamspeed)

# Usage

```js
const StreamSpeed = require('streamspeed');

let rs = fs.createReadStream('somefile.avi');
let ss = new StreamSpeed();
ss.add(rs);

// Listen for events emitted by streamspeed on the given stream.
ss.on('speed', (speed) => {
  console.log('Reading at', speed, 'bytes per second');
});
```

Keep track of a group of streams

```js
let group = new Streamspeed();
group.add(stream1);
group.add(stream2);
group.add(stream3);

group.on('speed', (speed) => {
  console.log('now reading at', speed, 'bps');
});
```

![example img](http://i.imgur.com/y47Sc.png)

# API
### new StreamSpeed([options])
A group that can be used to watch several streams. Will emit `speed` events. `options` can have the following properties,
- `timeUnit` - Defaults to `1000` for speed per second. If you want another unit such as per hour, use `1000 * 60 * 60`.
- `range` - The time in ms to calculate speed over. Defaults to `1000`. The longer this is, the more stable speed will be for a big stream. The shorter it is, the more responsive it is to sudden speed changes.

### StreamSpeed#add(stream)
Adds stream to group.

### StreamSpeed#remove(stream)
Removes stream from group.

### StreamSpeed#getSpeed()
Get current speed.

### StreamSpeed#getStreamSpeed(stream)
Get an individual's stream's current speed.

### StreamSpeed#getStreams()
Returns a list of all streams in the group.

### StreamSpeed.toHuman(bytes, options)
Helper method to convert `bytes` to a human readable string.

```js
StreamSpeed.toHuman(1500);                                  // 1.46KB
StreamSpeed.toHuman(1024 * 1024);                           // 1MB
StreamSpeed.toHuman(1024 * 1024 * 20.5, { timeUnit: 's' }); // 20.5MB/s
StreamSpeed.toHuman(1024 * 1024 * 20.5, { precision: 3 });  // 20.50MB
```

### Event: 'speed'
* `number` - Speed at which streams in the group are being read.

Will be emitted every time a stream is read and only if there is a change in speed.


# Install

    npm install streamspeed


# Tests
Tests are written with [mocha](https://mochajs.org)

```bash
npm test
```

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