Class: CommandProcess

vertx-shell-js/command_process~ CommandProcess

new CommandProcess()

The command process provides interaction with the process of the command provided by Vert.x Shell.
Source:

Methods

args() → {Array.<string>}

Source:
Returns:
  • the actual string arguments of the command
  • Type
    Array.<string>

argsTokens() → {Array.<CliToken>}

Source:
Returns:
  • the unparsed arguments tokens
  • Type
    Array.<CliToken>

commandLine() → {CommandLine}

Source:
Returns:
  • the command line object or null
  • Type
    CommandLine

end(status)

End the process.
Parameters:
Name Type Description
status number the exit status.
Source:

eventHandler(eventType, handler) → {CommandProcess}

Parameters:
Name Type Description
eventType Object
handler function
Source:
Returns:
Type
CommandProcess

session() → {Session}

Source:
Returns:
  • the shell session
  • Type
    Session

setStdin(stdin) → {CommandProcess}

Parameters:
Name Type Description
stdin Stream
Source:
Returns:
Type
CommandProcess

vertx() → {Vertx}

Source:
Returns:
  • the current Vert.x instance
  • Type
    Vertx

write(text) → {CommandProcess}

Parameters:
Name Type Description
text string
Source:
Returns:
Type
CommandProcess