kotlin-actions-toolkit/actions.cache

Package-level declarations

Types

ArchiveToolType

sealed external interface ArchiveToolType

CacheFilename

sealed external interface CacheFilename

CompressionMethod

sealed external interface CompressionMethod

DownloadOptions

sealed external interface DownloadOptions

DownloadProgress

external class DownloadProgress

ReserveCacheError

external class ReserveCacheError : Throwable

TransferProgressEvent

sealed external interface TransferProgressEvent

UploadOptions

sealed external interface UploadOptions

ValidationError

external class ValidationError : Throwable

Properties

DefaultRetryAttempts

const val DefaultRetryAttempts: Int = 2

DefaultRetryDelay

const val DefaultRetryDelay: Int = 5000

GnuTarPathOnWindows

external val GnuTarPathOnWindows: String

ManifestFilename

const val ManifestFilename: String

SocketTimeout

const val SocketTimeout: Int = 5000

SystemTarPathOnWindows

external val SystemTarPathOnWindows: String

TarFilename

const val TarFilename: String

Functions

assertDefined

external fun <T> assertDefined(name: String, value: T = definedExternally): T

createTar

suspend external fun createTar(archiveFolder: String, sourceDirectories: ReadonlyArray<String>, compressionMethod: CompressionMethod)

createTarAsync

external fun createTarAsync(archiveFolder: String, sourceDirectories: ReadonlyArray<String>, compressionMethod: CompressionMethod): Promise<Void>

createTempDirectory

suspend external fun createTempDirectory(): String

createTempDirectoryAsync

external fun createTempDirectoryAsync(): Promise<String>

downloadCache

suspend external fun downloadCache(archiveLocation: String, archivePath: String, options: DownloadOptions = definedExternally)

downloadCacheAsync

external fun downloadCacheAsync(archiveLocation: String, archivePath: String, options: DownloadOptions = definedExternally): Promise<Void>

downloadCacheHttpClient

suspend external fun downloadCacheHttpClient(archiveLocation: String, archivePath: String)

downloadCacheHttpClientAsync

external fun downloadCacheHttpClientAsync(archiveLocation: String, archivePath: String): Promise<Void>

downloadCacheHttpClientConcurrent

suspend external fun downloadCacheHttpClientConcurrent(archiveLocation: String, archivePath: PathLike, options: DownloadOptions)

downloadCacheHttpClientConcurrentAsync

external fun downloadCacheHttpClientConcurrentAsync(archiveLocation: String, archivePath: PathLike, options: DownloadOptions): Promise<Void>

downloadCacheStorageSDK

suspend external fun downloadCacheStorageSDK(archiveLocation: String, archivePath: String, options: DownloadOptions)

downloadCacheStorageSDKAsync

external fun downloadCacheStorageSDKAsync(archiveLocation: String, archivePath: String, options: DownloadOptions): Promise<Void>

extractTar

suspend external fun extractTar(archivePath: String, compressionMethod: CompressionMethod)

extractTarAsync

external fun extractTarAsync(archivePath: String, compressionMethod: CompressionMethod): Promise<Void>

getArchiveFileSizeInBytes

external fun getArchiveFileSizeInBytes(filePath: String): Number

getCacheFileName

external fun getCacheFileName(compressionMethod: CompressionMethod): String

getCacheVersion

external fun getCacheVersion(paths: ReadonlyArray<String>, compressionMethod: CompressionMethod = definedExternally, enableCrossOsArchive: Boolean = definedExternally): String

getCompressionMethod

suspend external fun getCompressionMethod(): CompressionMethod

getCompressionMethodAsync

external fun getCompressionMethodAsync(): Promise<CompressionMethod>

getDownloadOptions

external fun getDownloadOptions(copy: DownloadOptions = definedExternally): DownloadOptions

getGnuTarPathOnWindows

suspend external fun getGnuTarPathOnWindows(): String

getGnuTarPathOnWindowsAsync

external fun getGnuTarPathOnWindowsAsync(): Promise<String>

getUploadOptions

external fun getUploadOptions(copy: UploadOptions = definedExternally): UploadOptions

isFeatureAvailable

external fun isFeatureAvailable(): Boolean

isGhes

external fun isGhes(): Boolean

isRetryableStatusCode

external fun isRetryableStatusCode(statusCode: Number = definedExternally): Boolean

isServerErrorStatusCode

external fun isServerErrorStatusCode(statusCode: Number = definedExternally): Boolean

isSuccessStatusCode

external fun isSuccessStatusCode(statusCode: Number = definedExternally): Boolean

listTar

suspend external fun listTar(archivePath: String, compressionMethod: CompressionMethod)

listTarAsync

external fun listTarAsync(archivePath: String, compressionMethod: CompressionMethod): Promise<Void>

resolvePaths

suspend external fun resolvePaths(patterns: ReadonlyArray<String>): ReadonlyArray<String>

resolvePathsAsync

external fun resolvePathsAsync(patterns: ReadonlyArray<String>): Promise<ReadonlyArray<String>>

restoreCache

suspend external fun restoreCache(paths: ReadonlyArray<String>, primaryKey: String, restoreKeys: ReadonlyArray<String> = definedExternally, options: DownloadOptions = definedExternally, enableCrossOsArchive: Boolean = definedExternally): String?

restoreCacheAsync

external fun restoreCacheAsync(paths: ReadonlyArray<String>, primaryKey: String, restoreKeys: ReadonlyArray<String> = definedExternally, options: DownloadOptions = definedExternally, enableCrossOsArchive: Boolean = definedExternally): Promise<String?>

retry

suspend external fun <T> retry(name: String, method: () -> Promise<T>, getStatusCode: (arg0: T) -> Number?, maxAttempts: Number = definedExternally, delay: Number = definedExternally, onError: (JsError) -> T?? = definedExternally): T

retryAsync

external fun <T> retryAsync(name: String, method: () -> Promise<T>, getStatusCode: (arg0: T) -> Number?, maxAttempts: Number = definedExternally, delay: Number = definedExternally, onError: (JsError) -> T?? = definedExternally): Promise<T>

retryHttpClientResponse

suspend external fun retryHttpClientResponse(name: String, method: () -> Promise<HttpClientResponse>, maxAttempts: Number = definedExternally, delay: Number = definedExternally): HttpClientResponse

retryHttpClientResponseAsync

external fun retryHttpClientResponseAsync(name: String, method: () -> Promise<HttpClientResponse>, maxAttempts: Number = definedExternally, delay: Number = definedExternally): Promise<HttpClientResponse>

saveCache

suspend external fun saveCache(cacheId: Number, archivePath: String, options: UploadOptions = definedExternally)

suspend external fun saveCache(paths: ReadonlyArray<String>, key: String, options: UploadOptions = definedExternally, enableCrossOsArchive: Boolean = definedExternally): Number

saveCacheAsync

external fun saveCacheAsync(cacheId: Number, archivePath: String, options: UploadOptions = definedExternally): Promise<Void>

external fun saveCacheAsync(paths: ReadonlyArray<String>, key: String, options: UploadOptions = definedExternally, enableCrossOsArchive: Boolean = definedExternally): Promise<Number>

unlinkFile

suspend external fun unlinkFile(filePath: PathLike)

unlinkFileAsync

external fun unlinkFileAsync(filePath: PathLike): Promise<Void>