Class: WorkContext

task/work.WorkContext

Work Context

Description

• constructor

• provider
• activity

• before
• run
• spawn
• transfer
• uploadFile
• uploadJson
• uploadData
• downloadFile
• downloadData
• downloadJson
• beginBatch
• getWebsocketUri
• getIp
• getState

• new WorkContext(activity, options?): WorkContext

WorkContext

src/task/work.ts:59

• Readonly provider: ProviderInfo

src/task/work.ts:52

• Readonly activity: Activity

src/task/work.ts:60

▸ before(): Promise<void | Result<any>[]>

Promise<void | Result<any>[]>

src/task/work.ts:70

▸ run(commandLine, options?): Promise<Result<any>>

Execute a command on provider using a shell (/bin/sh).

Promise<Result<any>>

src/task/work.ts:167

▸ run(executable, args, options?): Promise<Result<any>>

Execute an executable on provider.

Promise<Result<any>>

src/task/work.ts:176

▸ spawn(commandLine, options?): Promise<RemoteProcess>

Spawn an executable on provider and return RemoteProcess object that contain stdout and stderr as Readable

Promise<RemoteProcess>

src/task/work.ts:200

▸ spawn(executable, args, options?): Promise<RemoteProcess>

Promise<RemoteProcess>

src/task/work.ts:206

▸ transfer(from, to, options?): Promise<Result<any>>

Generic transfer command, requires the user to provide a publicly readable transfer source

Promise<Result<any>>

src/task/work.ts:247

▸ uploadFile(src, dst, options?): Promise<Result<any>>

Promise<Result<any>>

src/task/work.ts:252

▸ uploadJson(json, dst, options?): Promise<Result<any>>

Promise<Result<any>>

src/task/work.ts:258

▸ uploadData(data, dst, options?): Promise<Result<any>>

Promise<Result<any>>

src/task/work.ts:264

▸ downloadFile(src, dst, options?): Promise<Result<any>>

Promise<Result<any>>

src/task/work.ts:269

▸ downloadData(src, options?): Promise<Result<Uint8Array>>

Promise<Result<Uint8Array>>

src/task/work.ts:274

▸ downloadJson(src, options?): Promise<Result<any>>

Promise<Result<any>>

src/task/work.ts:280

▸ beginBatch(): Batch

Batch

src/task/work.ts:296

▸ getWebsocketUri(port): string

string

src/task/work.ts:300

▸ getIp(): string

string

src/task/work.ts:312

▸ getState(): Promise<ActivityStateEnum>

Promise<ActivityStateEnum>

src/task/work.ts:324