[Artifacts] Prepare for v2.0.0 of @actions/artifact (#1479)

* Prepare for v2.0.0 of @actions/artifact

* Run prettier

* temporary disable unused vars
This commit is contained in:
Konrad Pabjan
2023-08-03 13:34:41 -04:00
committed by GitHub
parent 91d3933eb5
commit c4f5ce2665
44 changed files with 132 additions and 5896 deletions

View File

@@ -0,0 +1,44 @@
import {UploadOptions} from './upload/upload-options'
import {UploadResponse} from './upload/upload-response'
import {uploadArtifact} from './upload/upload-artifact'
export interface ArtifactClient {
/**
* Uploads an artifact
*
* @param name the name of the artifact, required
* @param files a list of absolute or relative paths that denote what files should be uploaded
* @param rootDirectory an absolute or relative file path that denotes the root parent directory of the files being uploaded
* @param options extra options for customizing the upload behavior
* @returns single UploadInfo object
*/
uploadArtifact(
name: string,
files: string[],
rootDirectory: string,
options?: UploadOptions
): Promise<UploadResponse>
// TODO Download functionality
}
export class Client implements ArtifactClient {
/**
* Constructs a Client
*/
static create(): Client {
return new Client()
}
/**
* Uploads an artifact
*/
async uploadArtifact(
name: string,
files: string[],
rootDirectory: string,
options?: UploadOptions | undefined
): Promise<UploadResponse> {
return uploadArtifact(name, files, rootDirectory, options)
}
}