import File from 'pipeline-transfer/functions/transfer/transfer/artifact/file.js'

public class | source

File

Represents a file inside an artifact.

Constructor Summary

Public Constructor
public	constructor(path: String, filename: String, absolutePath: String)

Public Members
public	absolutePath: String An absolute path to the underlying file
public get	contentType: String The determined mime type for the file
public get	data: *
public	key: String The S3 key which represents this file (path + filename)

Public Methods
public	async upload(opts: Object): string Uploads the file to the specific remote S3 bucket, using the supplied credentials and an optional prefix.

Name	Type	Attribute	Description
path	String		the path to the file inside the artifact
filename	String		The name of the file, including the extension name
absolutePath	String		An absolute path to the underlying file

An absolute path to the underlying file

The determined mime type for the file

The S3 key which represents this file (path + filename)

Uploads the file to the specific remote S3 bucket, using the supplied credentials and an optional prefix.

Name	Type	Attribute	Description
opts	Object		An options object
opts.bucket	String		The bucket to upload the file to.
opts.credentials	Credentials		An instantiated AWS.Credentials object.
opts.prefix	String		An optional prefix to apply to this file.