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

Package detail

hurricane-electric-bandwidth

ppicazo14MIT2.0.0

Retrieve the current 95th percentile bandwidth usage from a given switch port in Hurricane Electric.

readme

hurricane-electric-bandwidth

What is this?

Programatic method to retrieve your 95th percentile bandwidth usage.

Typical Usage

In your code

Add to your project

npm install hurricane-electric-bandwidth

Use it

var HurricaneElectricBandwidth = require('hurricane-electric-bandwidth');
Get bandwidth usage in bytes per second
HurricaneElectricBandwidth.bandwidthBytes('ABC==').then(bandwidthBytes => {
  console.log(bandwidthBytes);
});

1001000

Get bandwidth usage raw string
HurricaneElectricBandwidth.scrapBandwidthText('ABC==').then(bandwidthText => {
  console.log(bandwidthText);
});

1001 kb/s

Command line interface

Install

npm install -g hurricane-electric-bandwidth
hurricane-electric-bandwidth ABC123

1001000

hurricane-electric-bandwidth ABC123 --raw

1001 kb/s