Class ExitObject

An object that is returned when a command is executed.

Index

Constructors

Accessors

command timestamp exitCode userInput rawInput output stdoutLog stderrLog

Constructors

constructor

new ExitObject(
    userInput: string[],
    rawInput: string,
    command: Command | undefined,
    exitCode: number,
    output: any,
    stdoutLog?: any[],
    stderrLog?: any[],
): ExitObject
Parameters
- userInput: string[]
  the input array that was used to execute the command
- rawInput: string
  the raw input that was used to execute the command
- command: Command | undefined
  the command that was executed; undefined if the command is not found
- exitCode: number
  the exit code of the command
- output: any
  the output of the command
- stdoutLog: any[] = []
  the stdout log of the command
- stderrLog: any[] = []
  the stderr log of the command
Returns ExitObject
- Defined in src/commands.ts:292

Accessors

command

get command(): Command | undefined
Get the command that was executed.

Returns Command | undefined
- Defined in src/commands.ts:223

timestamp

get timestamp(): number
Get the timestamp of the execution.

Returns number
- Defined in src/commands.ts:231

exitCode

get exitCode(): number
Get the exit code of the execution.

Returns number
- Defined in src/commands.ts:239

userInput

get userInput(): string[]
Get the input that was used to execute the command.

Returns string[]
- Defined in src/commands.ts:247

rawInput

get rawInput(): string
Get the raw input that was entered to execute the command.

Returns string
- Defined in src/commands.ts:255

output

get output(): any
Get the output of the execution.

Returns any
- Defined in src/commands.ts:263

stdoutLog

get stdoutLog(): any[]
Get the stdout log of the execution.

Returns any[]
- Defined in src/commands.ts:271

stderrLog

get stderrLog(): any[]
Get the stderr log of the execution.

Returns any[]
- Defined in src/commands.ts:279