Class ProcessExecutor

constructor

• new ProcessExecutor(): ProcessExecutor

  Returns ProcessExecutor

append

logErrorsOnly

outputFile

outputPrefix

printToConsole

stopOnError

timeout

timeUnit

workingDir

execute

• execute(...command: string[]): string | undefined

  Parameters

  • ...command: string[]

    The command to be executed. Accepts a command as a sequence of strings, or as an array with strings.

  Returns string | undefined

getCommand

• getCommand(): string[] | undefined

  Returns string[] | undefined

getConsoleOutput

• getConsoleOutput(): string | undefined

  Returns string | undefined

getExecutableFile

• getExecutableFile(): File | undefined

  Returns File | undefined

  The file of the executable of the command, or undefined if could not locate the file.

getReturnValue

• getReturnValue(): number | undefined

  Returns number | undefined

getStdErr

• getStdErr(): string | undefined

  Returns string | undefined

getStdOut

• getStdOut(): string | undefined

  Returns string | undefined

getWorkingDir

• getWorkingDir(): string

  Returns string

setAppend

• setAppend(append?: boolean): ProcessExecutor

  Sets if the output should be appended to the output of the previous execution.

  Parameters

  • append: boolean = true

  Returns ProcessExecutor

setCustomReturnValue

• setCustomReturnValue(returnValue: string): this

  Parameters

  • returnValue: string

    An integer that represents the return value of the process executor

  Returns this

• setCustomReturnValue(returnValue: number): this

  Parameters

  • returnValue: number

    An integer that represents the return value of the process executor

  Returns this

setLogErrorsOnly

• setLogErrorsOnly(logErrorsOnly?: boolean): ProcessExecutor

  Parameters

  • logErrorsOnly: boolean = true

  Returns ProcessExecutor

setOutputFile

• setOutputFile(outputFile: string): ProcessExecutor

  Parameters

  • outputFile: string

  Returns ProcessExecutor

setOutputPrefix

• setOutputPrefix(outputPrefix: string): ProcessExecutor

  Parameters

  • outputPrefix: string

  Returns ProcessExecutor

setPrintToConsole

• setPrintToConsole(printToConsole?: boolean): ProcessExecutor

  Sets if the output of the process should be output to the console.

  Parameters

  • printToConsole: boolean = true

  Returns ProcessExecutor

setStopOnError

• setStopOnError(stopOnError?: boolean): ProcessExecutor

  If true, throws an exception if there is a problem when running the process. By default is set to 'false'.

  Parameters

  • stopOnError: boolean = true

  Returns ProcessExecutor

setTimeout

• setTimeout(timeout: number): ProcessExecutor

  Parameters

  • timeout: number

  Returns ProcessExecutor

setTimeUnit

• setTimeUnit(timeUnit: TimerUnit): ProcessExecutor

  Sets the time unit of the timeout value. By defaults, is SECONDS.

  Parameters

  • timeUnit: TimerUnit

  Returns ProcessExecutor

setWorkingDir

• setWorkingDir(workingDir: string): ProcessExecutor

  Parameters

  • workingDir: string

  Returns ProcessExecutor