Class NetworkBandwidthInformation

namespace: NetworkBandwidthInformation
class: NetworkBandwidthInformation
param: Provide the minimum file size of the files you want to get the bandwidth of.

Hierarchy

NetworkBandwidthInformation

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NetworkBandwidthInformation(minimumFileSize?: number): NetworkBandwidthInformation

- Defined in lib/NetworkBandwidthInformation.ts:13
Parameters
- Default value minimumFileSize: number = 10
  
  Provide the minimum file size of the files you want to get the bandwidth of.
Returns NetworkBandwidthInformation

Properties

Private _minSize

_minSize: number

averageBandwidth

averageBandwidth: number | undefined

Average of bandwidths property.

bandwidths

bandwidths: number[] | undefined

number[] containing all bandwidths.

Methods

getAverageBandwidth

getAverageBandwidth(): number | undefined

- Defined in lib/NetworkBandwidthInformation.ts:61
Returns an average of this.bandwidths

Returns undefined if there are no bandwidths matching the minimum file size requirement.

method

getAverageBandwidth

Returns number | undefined

getBandwidths

getBandwidths(): number[] | undefined

- Defined in lib/NetworkBandwidthInformation.ts:31
Returns an array of all bandwidths.

Returns undefined if there are no bandwidths matching the minimum file size requirement.

method

getBandwidths

Returns number[] | undefined

Generated using TypeDoc