Result | @amilajack/joker

Hierarchy

Result

Index

Constructors

constructor

Properties

Methods

parse
strip

Constructors

constructor

new Result(cmd: string, code: number, options?: Options): Result

- Defined in src/result.ts:57
Parameters
- cmd: string
- code: number
- Default value options: Options = DEFAULT_OPTIONS
Returns Result

Properties

cmd

cmd: string = ""

code

code: number = 0

err

err: ResultError

killed

killed: boolean = false

stderr

stderr: string = ""

stdout

stdout: string = ""

Methods

parse

parse(stdout: string, stderr: string, err: ResultError | undefined): Result

- Defined in src/result.ts:76
Normalize the command-line result.

Parameters
- stdout: string
- stderr: string
- err: ResultError | undefined
Returns Result

Private strip

strip(str: string): string

- Defined in src/result.ts:106
Result#strip will do the following:
- Remove the last new line symbol from the string (always)
- Strip new lines (optional, see options)
- Strip colors (optional, see options)
Acknowledgments:
- StripColorCodes - MIT License
Parameters
- str: string
Returns string

Generated using TypeDoc