Kotlin Wrappers API Reference

kotlin-actions-cache/actions.cache/UploadProgress

UploadProgress

external class UploadProgress(source)

Constructors

constructor(contentLength: Number)

Properties

var contentLength: Number

displayedComplete

var displayedComplete: Boolean

var sentBytes: Number

var startTime: Number

var timeoutHandle: <Error class: unknown class>?

Functions

Prints the current upload stats. Once the upload 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 upload is complete.

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

Returns a function used to handle TransferProgressEvents.

fun setSentBytes(sentBytes: Number)

Sets the number of bytes sent

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 upload is complete, this will display one last line, unless the last line has already been written.