Class: WorkContext

task/work.WorkContext

Work Context

Description

• constructor

• provider
• agreementId
• activityId

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

• new WorkContext(activity, options?)

src/task/work.ts:60

• Optional Readonly provider: Object

src/task/work.ts:51

• Readonly agreementId: string

src/task/work.ts:52

• Readonly activityId: string

src/task/work.ts:53

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

Promise<void | Result<any>[]>

src/task/work.ts:73

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

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

Promise<Result<any>>

src/task/work.ts:116

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

Execute an executable on provider.

Promise<Result<any>>

src/task/work.ts:125

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

Promise<Result<any>>

src/task/work.ts:137

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

Promise<Result<any>>

src/task/work.ts:142

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

Promise<Result<any>>

src/task/work.ts:147

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

Promise<Result<any>>

src/task/work.ts:151

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

Promise<Result<Uint8Array>>

src/task/work.ts:155

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

Promise<Result<any>>

src/task/work.ts:160

▸ beginBatch(): Batch

Batch

src/task/work.ts:175

▸ rejectResult(msg): void

void

Deprecated

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

src/task/work.ts:182

▸ getWebsocketUri(port): string

string

src/task/work.ts:186

▸ getState(): Promise<ActivityStateEnum>

Promise<ActivityStateEnum>

src/task/work.ts:191