Class CliUsageError

Thrown to print usage documentation and an error message

Hierarchy

Error
- CliUsageError

Index

Constructors

constructor

Properties

Constructors

constructor

new CliUsageError(message?: undefined | string, tree?: ICliTree): CliUsageError

- Defined in src/cli-usage-error.ts:14
Parameters
- Optional message: undefined | string
  
  If provided, ICli.run will also print "Error: <your message>"
- Optional tree: ICliTree
  
  Used internally for constructing the command-line usage string
Returns CliUsageError

Properties

code

code: typeof CLI_USAGE_ERROR

The string constant CLI_USAGE_ERROR

message

message: string

name

name: string

Optional stack

stack: undefined | string

Optional tree

Used internally for generating usage documentation

Static Error

Error: ErrorConstructor

Generated using TypeDoc and MonoLisa