Class processExecutor

constructor

• new processExecutor(): processExecutor

• Returns processExecutor

append

logErrorsOnly

outputFile

outputPrefix

printToConsole

stopOnError

timeout

timeUnit

workingDir

execute

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

• Parameters

  • Rest...command: string[]

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

  Returns undefined | string

getCommand

• getCommand(): undefined | string[]

• Returns undefined | string[]

getConsoleOutput

• getConsoleOutput(): undefined | string

• Returns undefined | string

getExecutableFile

• getExecutableFile(): undefined | File

• Returns undefined | File

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

getReturnValue

• getReturnValue(): undefined | number

• Returns undefined | number

getStdErr

• getStdErr(): undefined | string

• Returns undefined | string

getStdOut

• getStdOut(): undefined | string

• Returns undefined | string

getWorkingDir

• getWorkingDir(): string

• Returns string

setAppend

• setAppend(append?): processExecutor

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

  Parameters

  • append: boolean = true

  Returns processExecutor

setCustomReturnValue

• setCustomReturnValue(returnValue): this

• Parameters

  • returnValue: string

    An integer that represents the return value of the process executor

  Returns this

• setCustomReturnValue(returnValue): this

• Parameters

  • returnValue: number

  Returns this

setLogErrorsOnly

• setLogErrorsOnly(logErrorsOnly?): processExecutor

• Parameters

  • logErrorsOnly: boolean = true

  Returns processExecutor

setOutputFile

• setOutputFile(outputFile): processExecutor

• Parameters

  • outputFile: string

  Returns processExecutor

setOutputPrefix

• setOutputPrefix(outputPrefix): processExecutor

• Parameters

  • outputPrefix: string

  Returns processExecutor

setPrintToConsole

• setPrintToConsole(printToConsole?): processExecutor

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

  Parameters

  • printToConsole: boolean = true

  Returns processExecutor

setStopOnError

• setStopOnError(stopOnError?): 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): processExecutor

• Parameters

  • timeout: number

  Returns processExecutor

setTimeUnit

• setTimeUnit(timeUnit): processExecutor

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

  Parameters

  • timeUnit: TimerUnit

  Returns processExecutor

setWorkingDir

• setWorkingDir(workingDir): processExecutor

• Parameters

  • workingDir: string

  Returns processExecutor