Constructor
# new DefineCommand()
Defines a variable that can later be used in the script
Command syntax:
defined var_name [value|command|
args:
- var_name: string : this variable with be replaced in every subsequent command
- value|command: string: a value, or a command that will be executed and its result stored as the variable
- Source object:
- any;
Defines a variable that can later be used in the script
Command syntax:
defined var_name [value|command|
args:
- var_name: string : this variable with be replaced in every subsequent command
- value|command: string: a value, or a command that will be executed and its result stored as the variable
- Source object:
- any;
Extends
Methods
# protected _parseCommand(command, next, callback)
Should be overridden by child classes if any argument parsing is required
.Should be overridden by child classes if any argument parsing is required
Parameters:
| Name | Type | Description |
|---|---|---|
command |
Array.<string>
|
string
|
boolean
|
the command split into words |
next |
Array.<string>
|
the following Commands |
callback |
function
|
- Inherited From:
# protected _runCommand(arg, baropt, options, callback)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
arg |
string
|
object
|
the command argument |
|
bar |
Archive
|
<optional> |
|
options |
object
|
||
callback |
function
|
- Inherited From:
# execute(args, baropt, nextopt, optionsopt, callback)
Parses the command text and executes the command onto the provided DSU
.Parses the command text and executes the command onto the provided DSU
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
args |
Array.<string>
|
string
|
the arguments of the command split into words |
|
bar |
Archive
|
KeySSI
|
<optional> |
the destinationDSU or the keySSI |
next |
Array.<string>
|
<optional> |
the remaining commands |
options |
object
|
<optional> |
|
callback |
function
|
- Inherited From: