kotlin-actions-cache/actions.cache/UploadProgress

UploadProgress

open external class UploadProgress(source)

Constructors

constructor(contentLength: Number)

Properties

external var contentLength: Number

displayedComplete

external var displayedComplete: Boolean

external var sentBytes: Number

external var startTime: Number

external var timeoutHandle: Timeout?

Functions

external fun display()

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

getTransferredBytes

external fun getTransferredBytes(): Number

Returns the total number of bytes transferred.

external fun isDone(): Boolean

Returns true if the upload is complete.

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

Returns a function used to handle TransferProgressEvents.

external fun setSentBytes(sentBytes: Number)

Sets the number of bytes sent

startDisplayTimer

external fun startDisplayTimer(delayInMs: Number = definedExternally)

Starts the timer that displays the stats.

stopDisplayTimer

external fun stopDisplayTimer()

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