Class: WorkContext

task/work.WorkContext

Work Context

Description

• constructor

• provider
• agreementId
• activityId

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

• new WorkContext(activity, options?)

src/task/work.ts:61

• Optional Readonly provider: Object

src/task/work.ts:52

• Readonly agreementId: string

src/task/work.ts:53

• Readonly activityId: string

src/task/work.ts:54

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

Promise<void | Result<any>[]>

src/task/work.ts:74

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

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

Promise<Result<any>>

src/task/work.ts:117

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

Execute an executable on provider.

Promise<Result<any>>

src/task/work.ts:126

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

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

Promise<Result<any>>

src/task/work.ts:149

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

Promise<Result<any>>

src/task/work.ts:154

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

Promise<Result<any>>

src/task/work.ts:159

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

Promise<Result<any>>

src/task/work.ts:163

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

Promise<Result<Uint8Array>>

src/task/work.ts:167

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

Promise<Result<any>>

src/task/work.ts:172

▸ beginBatch(): Batch

Batch

src/task/work.ts:187

▸ rejectResult(msg): void

void

Deprecated

This function is only used to throw errors from unit tests. It should be removed.

src/task/work.ts:194

▸ getWebsocketUri(port): string

string

src/task/work.ts:198

▸ getIp(): string

string

src/task/work.ts:203

▸ getState(): Promise<ActivityStateEnum>

Promise<ActivityStateEnum>

src/task/work.ts:208