• ------------------------------
  • JS API Reference

    Class: Command<T>

    activity/script/command.Command

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

    Type parameters

    NameType
    Tunknown

    Hierarchy

    Table of contents

    Constructors

    Properties

    Methods

    Constructors

    constructor

    new Command<T>(commandName, args?): Command<T>

    Type parameters

    NameType
    Tunknown

    Parameters

    NameType
    commandNamestring
    args?Record<string, unknown>

    Returns

    Command<T>

    Defined in

    src/activity/script/command.ts:18

    Properties

    args

    Protected args: Record<string, unknown>

    Defined in

    src/activity/script/command.ts:16

    Methods

    toJson

    toJson(): Object

    Serializes the command to a JSON representation

    Returns

    Object

    Defined in

    src/activity/script/command.ts:28


    toExeScriptRequest

    toExeScriptRequest(): ExeScriptRequest

    Converts the command into

    Returns

    ExeScriptRequest

    Defined in

    src/activity/script/command.ts:37


    before

    before(): Promise<void>

    Setup local environment for executing this command.

    Returns

    Promise<void>

    Defined in

    src/activity/script/command.ts:44


    after

    after(result?): Promise<Result<T>>

    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
    result?Result<T>

    Returns

    Promise<Result<T>>

    Defined in

    src/activity/script/command.ts:57