Interface IDbgCmd

Identifies a basic command definition. It provides for a command description optional argument help details and the execute function.

interface IDbgCmd {
    argHelp?: DbgCmdArgHelp;
    desc: string;
    exec: (context: IDbgCmdContext, ...extraArgs: any[]) => any;
}

Index

Properties

argHelp? desc exec

Properties

`Optional`argHelp

argHelp?: DbgCmdArgHelp

Optiona argument help

desc

desc: string

The description of the command

exec

exec: (context: IDbgCmdContext, ...extraArgs: any[]) => any

This function executes the command with the command context and any optional arguments to be passed to the command.

Type Declaration

- (context: IDbgCmdContext, ...extraArgs: any[]): any
- Parameters
  - context: IDbgCmdContext
    The command context provided by the runtime to the command so that it can perform additional operations
  - ...extraArgs: any[]
    Any additional optional arguments are passed as extra arguments to the function, if more than 1 argument is passed then there will be additional arguments.
  Returns any
  A result of the command that may be stored by the runtime