Class: DownloadFile

activity/script/command.DownloadFile

Generic command that can be send to an exe-unit via yagna's API

• Transfer

  ↳ DownloadFile

• constructor

• from
• to
• args

• before
• after
• toJson
• toExeScriptRequest

• new DownloadFile(storageProvider, srcPath, dstPath): DownloadFile

DownloadFile

Transfer.constructor

src/activity/script/command.ts:159

• Protected Optional from: string

Transfer.from

src/activity/script/command.ts:110

• Protected Optional to: string

Transfer.to

src/activity/script/command.ts:111

• Protected args: Record<string, unknown>

Transfer.args

src/activity/script/command.ts:16

▸ before(): Promise<void>

Setup local environment for executing this command.

Promise<void>

Transfer.before

src/activity/script/command.ts:168

▸ after(result): Promise<Result<any>>

Cleanup local setup that was needed for the command to run.

It is called after the command was sent to the activity, and the command was processed.

When run within scripts or batch commands, after() might be called without any results, as one of the previous commands might have failed. In this case, the command should still cleanup its local setup and return an empty error result.

Promise<Result<any>>

Transfer.after

src/activity/script/command.ts:172

▸ toJson(): Object

Serializes the command to a JSON representation

Object

Transfer.toJson

src/activity/script/command.ts:28

▸ toExeScriptRequest(): ExeScriptRequest

Converts the command into

ExeScriptRequest

Transfer.toExeScriptRequest

src/activity/script/command.ts:37