@substrate-system/throughput

throughput

Speed measurement

Contents

• fork
• install
• Usage
• License

fork

This is a fork of ThaUnknown/throughput.

install

npm i -S @substrate-system/throughput

Usage

Import as normal.

import { throughput } from '@substrate-system/throughput'
import fs from 'node: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)  // use a 20s buffer instead

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

License

MIT