Class FolderUploaderHelper

Helper class/method for uploading a generic file, returning the proper folder uploader as required.

Export

Index

Constructors

Methods

cachedUploadGit upload

Constructors

constructor

new FolderUploaderHelper(): FolderUploaderHelper
Returns FolderUploaderHelper

Methods

`Static` cachedUploadGit

cachedUploadGit(from, hpcName, userId, connector?): Promise<CachedFolderUploader>
Uploads a generic folder and returns the helper used to do so. Uses the cached versions of everything. Only supported for git folders currently.
Parameters
- from: GitFolder
  either a GlobusFolder, GitFolder, or LocalFolder
- hpcName: string
  name of hpc to uplaod to
- userId: string
  current user
- Optional connector: null | Connector = null
  connector to connect to HPC with, if needed
Returns Promise<CachedFolderUploader>
folder uploader object used to upload the folder, can check if upload was successful via {uploader}.isComplete

Static
Throws
invalid file type/format
- Defined in src/FolderUploader.ts:586

`Static` upload

upload(from, hpcName, userId, jobId?, connector?): Promise<BaseFolderUploader>
Uploads a generic folder and returns the helper used to do so.
Parameters
- from: BaseFolder
  either a GlobusFolder, GitFolder, or LocalFolder
- hpcName: string
  name of hpc to uplaod to
- userId: string
  current user
- Optional jobId: string = ""
  job associated with the folder upload (optional)
- Optional connector: null | Connector = null
  connector to connect to HPC with, if needed
Returns Promise<BaseFolderUploader>
folder uploader object used to upload the folder, can check if upload was successful via {uploader}.isComplete

Static
Throws
invalid file type/format
- Defined in src/FolderUploader.ts:522

Generated using TypeDoc