JS API Reference

Class: Result<TData>

activity/results.Result

Type parameters

NameType
TDataany

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Result<TData>(props): Result<TData>

Type parameters

NameType
TDataany

Parameters

NameType
propsResultData<any>

Returns

Result<TData>

Defined in

src/activity/results.ts:40

Properties

index

index: number

Index of script command

Implementation of

ResultData.index

Defined in

src/activity/results.ts:31


eventDate

eventDate: string

The datetime of the event on which the result was received

Implementation of

ResultData.eventDate

Defined in

src/activity/results.ts:32


result

result: ExeScriptCommandResultResultEnum

If is success

Implementation of

ResultData.result

Defined in

src/activity/results.ts:33


stdout

Optional stdout: null | string | ArrayBuffer

stdout of script command

Implementation of

ResultData.stdout

Defined in

src/activity/results.ts:34


stderr

Optional stderr: null | string | ArrayBuffer

stderr of script command

Implementation of

ResultData.stderr

Defined in

src/activity/results.ts:35


message

Optional message: null | string

an error message if the result is not successful

Implementation of

ResultData.message

Defined in

src/activity/results.ts:36


isBatchFinished

Optional isBatchFinished: boolean

Is batch of already finished

Implementation of

ResultData.isBatchFinished

Defined in

src/activity/results.ts:37


data

Optional data: TData

In case the command was related to upload or download, this will contain the transferred data

Implementation of

ResultData.data

Defined in

src/activity/results.ts:38

Methods

getOutputAsJson

getOutputAsJson<Output>(): Output

Helper method making JSON-like output results more accessible

Type parameters

NameType
Outputobject

Returns

Output

Defined in

src/activity/results.ts:54

Was this helpful?