track upload and download speed on a hyperdrive archive
JavaScript
Clone or download

readme.md

hyperdrive-network-speed

Travis npm

Get upload and download speeds for a hyperdrive archive.

Usage

var archive = hyperdrive('.dat')
var swarm = hyperdiscovery(archive)
var speed = networkSpeed(archive, {timeout: 1000})

setInterval(function () {
  console.log('upload speed: ', speed.uploadSpeed)
  console.log('download speed: ', speed.downloadSpeed)
}, 500)

API

var speed = networkSpeed(archive, [opts])

  • archive is a hyperdrive archive.
  • opts.timeout is the only option. Speed will be reset to zero after the timeout.

speed.uploadSpeed

Archive upload speed across all peers.

speed.downloadSpeed

Archive download speed across all peers.

speed.downloadTotal

Archive total download.

speed.uploadTotal

Archive total upload.

License

MIT