Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommandProcess

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

Hierarchy

  • Tty
    • CommandProcess

Index

Methods

args

  • args(): string
  • Returns string

argsTokens

  • Returns CliToken

backgroundHandler

  • backgroundHandler(handler: ((res: void) => void) | Handler<void>): CommandProcess
  • Set a background handler, this handler is called when the command is running and put to background.

    Parameters

    • handler: ((res: void) => void) | Handler<void>

    Returns CommandProcess

commandLine

  • commandLine(): CommandLine
  • Returns CommandLine

end

  • end(): void
  • end(status: number): void
  • End the process with the exit status

    Returns void

  • End the process.

    Parameters

    • status: number

    Returns void

endHandler

  • endHandler(handler: ((res: void) => void) | Handler<void>): CommandProcess
  • Set an end handler, this handler is called when the command is ended, for instance the command is running and the shell closes.

    Parameters

    • handler: ((res: void) => void) | Handler<void>

    Returns CommandProcess

foregroundHandler

  • foregroundHandler(handler: ((res: void) => void) | Handler<void>): CommandProcess
  • Set a foreground handler, this handler is called when the command is running and put to foreground.

    Parameters

    • handler: ((res: void) => void) | Handler<void>

    Returns CommandProcess

height

  • height(): number
  • Returns number

interruptHandler

  • interruptHandler(handler: ((res: void) => void) | Handler<void>): CommandProcess
  • Set an interrupt handler, this handler is called when the command is interrupted, for instance user press Ctrl-C.

    Parameters

    • handler: ((res: void) => void) | Handler<void>

    Returns CommandProcess

isForeground

  • isForeground(): boolean
  • Returns boolean

resizehandler

  • resizehandler(handler: ((res: void) => void) | Handler<void>): CommandProcess
  • Parameters

    • handler: ((res: void) => void) | Handler<void>

    Returns CommandProcess

resumeHandler

  • resumeHandler(handler: ((res: void) => void) | Handler<void>): CommandProcess
  • Set a resume handler, this handler is called when the command is resumed, for instance user types bg or fg to resume the command.

    Parameters

    • handler: ((res: void) => void) | Handler<void>

    Returns CommandProcess

session

  • Returns Session

stdinHandler

  • stdinHandler(handler: ((res: string) => void) | Handler<string>): CommandProcess
  • Parameters

    • handler: ((res: string) => void) | Handler<string>

    Returns CommandProcess

suspendHandler

  • suspendHandler(handler: ((res: void) => void) | Handler<void>): CommandProcess
  • Set a suspend handler, this handler is called when the command is suspended, for instance user press Ctrl-Z.

    Parameters

    • handler: ((res: void) => void) | Handler<void>

    Returns CommandProcess

type

  • type(): string
  • Returns string

vertx

  • vertx(): Vertx
  • Returns Vertx

width

  • width(): number
  • Returns number

write

  • Write some text to the standard output.

    Parameters

    • data: string

    Returns CommandProcess

Generated using TypeDoc