JS API Reference

Class: DownloadData

activity/script/command.DownloadData

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

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new DownloadData(storageProvider, srcPath): DownloadData

Parameters

NameType
storageProviderStorageProvider
srcPathstring

Returns

DownloadData

Overrides

Transfer.constructor

Defined in

src/activity/script/command.ts:181

Properties

from

Protected Optional from: string

Inherited from

Transfer.from

Defined in

src/activity/script/command.ts:110


to

Protected Optional to: string

Inherited from

Transfer.to

Defined in

src/activity/script/command.ts:111


args

Protected args: Record<string, unknown>

Inherited from

Transfer.args

Defined in

src/activity/script/command.ts:16

Methods

before

before(): Promise<void>

Setup local environment for executing this command.

Returns

Promise<void>

Overrides

Transfer.before

Defined in

src/activity/script/command.ts:189


after

after(result): Promise<Result<Uint8Array>>

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.

Parameters

NameType
resultResult<any>

Returns

Promise<Result<Uint8Array>>

Overrides

Transfer.after

Defined in

src/activity/script/command.ts:196


toJson

toJson(): Object

Serializes the command to a JSON representation

Returns

Object

Inherited from

Transfer.toJson

Defined in

src/activity/script/command.ts:28


toExeScriptRequest

toExeScriptRequest(): ExeScriptRequest

Converts the command into

Returns

ExeScriptRequest

Inherited from

Transfer.toExeScriptRequest

Defined in

src/activity/script/command.ts:37