SpeedSummary interface

Package:

azure-storage

Extends

EventEmitter

Properties

completeSize
name
totalSize

Methods

getAutoIncrementFunction(number)	Get auto increment function
getAverageSpeed(boolean)	Get average upload/download speed
getCompletePercent(number)	Get complete percentage
getCompleteSize(boolean)	Get completed data size
getElapsedSeconds(boolean)	Get running seconds
getSpeed(boolean)	Get instant speed
getTotalSize(boolean)	Get total size
increment(number)	Increment the complete data size

Inherited Methods

addListener(string, Function)
emit(string, any[])
listeners(string)
on(string, Function)
once(string, Function)
removeAllListeners(string)
removeListener(string, Function)
setMaxListeners(number)

Property Details

completeSize

completeSize: number

Property Value

number

name

name: string

Property Value

string

totalSize

totalSize: number

Property Value

number

Method Details

getAutoIncrementFunction(number)

Get auto increment function

function getAutoIncrementFunction(size: number): (error: any, retValue: number) => void

Parameters

size

number

Returns

(error: any, retValue: number) => void

getAverageSpeed(boolean)

Get average upload/download speed

function getAverageSpeed(humanReadable: boolean): string

Parameters

humanReadable

boolean

Returns

string

getCompletePercent(number)

Get complete percentage

function getCompletePercent(len: number): number

Parameters

len

number

The number of digits after the decimal point.

Returns

number

getCompleteSize(boolean)

Get completed data size

function getCompleteSize(humanReadable: boolean): string | number

Parameters

humanReadable

boolean

Returns

string | number

getElapsedSeconds(boolean)

Get running seconds

function getElapsedSeconds(humanReadable: boolean): number

Parameters

humanReadable

boolean

Returns

number

getSpeed(boolean)

Get instant speed

function getSpeed(humanReadable: boolean): string | number

Parameters

humanReadable

boolean

Returns

string | number

getTotalSize(boolean)

Get total size

function getTotalSize(humanReadable: boolean): string | number

Parameters

humanReadable

boolean

Returns

string | number

increment(number)

Increment the complete data size

function increment(len: number): number

Parameters

len

number

Returns

number

Inherited Method Details

addListener(string, Function)

function addListener(event: string, listener: Function): SpeedSummary

Parameters

event

string

listener

Function

Returns

azure-storage.export=.common.streams.speedsummary.SpeedSummary

Inherited From events.EventEmitter.addListener

emit(string, any[])

function emit(event: string, args: any[]): boolean

Parameters

event

string

args

any[]

Returns

boolean

Inherited From events.EventEmitter.emit

listeners(string)

function listeners(event: string): Function[]

Parameters

event

string

Returns

Function[]

Inherited From events.EventEmitter.listeners

on(string, Function)

function on(event: string, listener: Function): SpeedSummary

Parameters

event

string

listener

Function

Returns

azure-storage.export=.common.streams.speedsummary.SpeedSummary

Inherited From events.EventEmitter.on

once(string, Function)

function once(event: string, listener: Function): SpeedSummary

Parameters

event

string

listener

Function

Returns

azure-storage.export=.common.streams.speedsummary.SpeedSummary

Inherited From events.EventEmitter.once

removeAllListeners(string)

function removeAllListeners(event?: string): SpeedSummary

Parameters

event

string

Returns

azure-storage.export=.common.streams.speedsummary.SpeedSummary

Inherited From events.EventEmitter.removeAllListeners

removeListener(string, Function)

function removeListener(event: string, listener: Function): SpeedSummary

Parameters

event

string

listener

Function

Returns

azure-storage.export=.common.streams.speedsummary.SpeedSummary

Inherited From events.EventEmitter.removeListener

setMaxListeners(number)

function setMaxListeners(n: number)

Parameters

n

number

Inherited From events.EventEmitter.setMaxListeners