kotlin-actions-toolkit/actions.cache/DownloadProgress

DownloadProgress

external class DownloadProgress(source)

Constructors

DownloadProgress

constructor(contentLength: Number)

Properties

var contentLength: Number

displayedComplete

var displayedComplete: Boolean

var receivedBytes: Number

var segmentIndex: Number

var segmentOffset: Number

var segmentSize: Number

var startTime: Number

var timeoutHandle: Timeout?

Functions

Prints the current download stats. Once the download completes, this will print one last line and then stop.

getTransferredBytes

fun getTransferredBytes(): Number

Returns the total number of bytes transferred.

fun isDone(): Boolean

Returns true if the download is complete.

fun nextSegment(segmentSize: Number)

Progress to the next segment. Only call this method when the previous segment is complete.

fun onProgress(): (progress: TransferProgressEvent) -> Unit

Returns a function used to handle TransferProgressEvents.

setReceivedBytes

fun setReceivedBytes(receivedBytes: Number)

Sets the number of bytes received for the current segment.

startDisplayTimer

fun startDisplayTimer(delayInMs: Number = definedExternally)

Starts the timer that displays the stats.

stopDisplayTimer

fun stopDisplayTimer()

Stops the timer that displays the stats. As this typically indicates the download is complete, this will display one last line, unless the last line has already been written.