mlugg
0a889b2ab1
Version 3 of `@actions/cache` is now deprecated, and can cause runs to fail; see https://github.com/actions/toolkit/blob/main/packages/cache/README.md. I have no fucking clue why this was considered a major release; it's explicitly documented as being entirely backwards-compatible. SemVer be damned, amirite?
61 lines
1.9 KiB
TypeScript
61 lines
1.9 KiB
TypeScript
import { BlobUploadCommonResponse } from '@azure/storage-blob';
|
|
import { TransferProgressEvent } from '@azure/ms-rest-js';
|
|
import { UploadOptions } from '../options';
|
|
/**
|
|
* Class for tracking the upload state and displaying stats.
|
|
*/
|
|
export declare class UploadProgress {
|
|
contentLength: number;
|
|
sentBytes: number;
|
|
startTime: number;
|
|
displayedComplete: boolean;
|
|
timeoutHandle?: ReturnType<typeof setTimeout>;
|
|
constructor(contentLength: number);
|
|
/**
|
|
* Sets the number of bytes sent
|
|
*
|
|
* @param sentBytes the number of bytes sent
|
|
*/
|
|
setSentBytes(sentBytes: number): void;
|
|
/**
|
|
* Returns the total number of bytes transferred.
|
|
*/
|
|
getTransferredBytes(): number;
|
|
/**
|
|
* Returns true if the upload is complete.
|
|
*/
|
|
isDone(): boolean;
|
|
/**
|
|
* Prints the current upload stats. Once the upload completes, this will print one
|
|
* last line and then stop.
|
|
*/
|
|
display(): void;
|
|
/**
|
|
* Returns a function used to handle TransferProgressEvents.
|
|
*/
|
|
onProgress(): (progress: TransferProgressEvent) => void;
|
|
/**
|
|
* Starts the timer that displays the stats.
|
|
*
|
|
* @param delayInMs the delay between each write
|
|
*/
|
|
startDisplayTimer(delayInMs?: number): void;
|
|
/**
|
|
* 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.
|
|
*/
|
|
stopDisplayTimer(): void;
|
|
}
|
|
/**
|
|
* Uploads a cache archive directly to Azure Blob Storage using the Azure SDK.
|
|
* This function will display progress information to the console. Concurrency of the
|
|
* upload is determined by the calling functions.
|
|
*
|
|
* @param signedUploadURL
|
|
* @param archivePath
|
|
* @param options
|
|
* @returns
|
|
*/
|
|
export declare function uploadCacheArchiveSDK(signedUploadURL: string, archivePath: string, options?: UploadOptions): Promise<BlobUploadCommonResponse>;
|