Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Commander

Takes care of creating commands to be sent to the server.

Holds the instance_id of the current environment, which will be sent along with other parameters in each call.

A command consists of:

{
  method: 'method_name', // api method's name exposed by the server
  params: {...} // a collection of parameters to be passed to the method API
}

Hierarchy

  • Commander

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Commander(instanceId: string): Commander

Properties

instanceId

instanceId: string = ""

Environment's id.

Methods

make

  • Creates a new command with the environment's id as parameter.

    Parameters

    • method: string

      API name.

    • Default value params: Dict<any> = {}

      Parameters for the API method.

    Returns Command

    Command sent to the server.

Generated using TypeDoc