Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

throughput

ThaUnknown33kMIT1.0.1

Speed measurment

throughput, speedometer, bandwidth, meter

readme

throughput

Speed measurement

npm install throughput

Usage

const throughput = require('throughput')
const fs = require('fs')

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

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

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

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

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

const speed = throughput(20) // uses a 20s buffer instead

This is an improved version of speedometer by mafintosh, which used timeouts, which cause a lot of issues.

License

MIT