Class: WorkContext

task/work.WorkContext

Groups most common operations that the requestors might need to implement their workflows

• constructor

• provider
• activity

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

• new WorkContext(activity, options): WorkContext

WorkContext

src/task/work.ts:61

• Readonly provider: ProviderInfo

src/task/work.ts:55

• Readonly activity: Activity

src/task/work.ts:62

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

Promise<void | Result<any>[]>

src/task/work.ts:75

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

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

Promise<Result<any>>

src/task/work.ts:172

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

Execute an executable on provider.

Promise<Result<any>>

src/task/work.ts:181

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

Promise<RemoteProcess>

Deprecated

Use WorkContext.runAndStream instead

src/task/work.ts:199

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

Promise<RemoteProcess>

Deprecated

Use WorkContext.runAndStream instead

src/task/work.ts:201

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

Run an executable on provider and return RemoteProcess that will allow streaming that contain stdout and stderr as Readable

Promise<RemoteProcess>

src/task/work.ts:218

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

Promise<RemoteProcess>

src/task/work.ts:224

▸ 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:266

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

Promise<Result<any>>

src/task/work.ts:271

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

Promise<Result<any>>

src/task/work.ts:277

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

Promise<Result<any>>

src/task/work.ts:283

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

Promise<Result<any>>

src/task/work.ts:288

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

Promise<Result<Uint8Array>>

src/task/work.ts:293

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

Promise<Result<any>>

src/task/work.ts:299

▸ beginBatch(): Batch

Batch

src/task/work.ts:315

▸ getWebsocketUri(port): string

Provides a WebSocket URI that allows communicating with a remote process listening on the target port

string

src/task/work.ts:324

▸ getIp(): string

string

src/task/work.ts:337

▸ createTcpProxy(portOnProvider): TcpProxy

Creates a new TCP proxy that will allow tunnelling the TPC traffic from the provider via the requestor

TcpProxy

src/task/work.ts:354

▸ getState(): Promise<ActivityStateEnum>

Promise<ActivityStateEnum>

src/task/work.ts:360