Class Cli

Hierarchy

Cli

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Cli(programDefinition: CliProgramDefinition, version?: string, cliOptions?: CliOptions): Cli

- Defined in src/Cli.ts:27
Parameters
- programDefinition: CliProgramDefinition
- Optional version: string
- Default value cliOptions: CliOptions = {}
Returns Cli

Properties

Private cliOptions

cliOptions: CliOptions

Private programDefinition

programDefinition: CliProgramDefinition

Private Optional version

version: string

Methods

parse

parse(argv?: string[]): ParsedCliCommand

- Defined in src/Cli.ts:34
Parameters
- Default value argv: string[] = process.argv
Returns ParsedCliCommand

start

start(argv?: string[]): Promise<CliRunResult>

- Defined in src/Cli.ts:48
Parameters
- Default value argv: string[] = process.argv
Returns Promise<CliRunResult>

Static parse

parse(programDefinition: CliProgramDefinition, version?: string, cliOptions?: CliOptions, argv?: string[]): ParsedCliCommand

- Defined in src/Cli.ts:19
Parameters
- programDefinition: CliProgramDefinition
- Optional version: string
- Default value cliOptions: CliOptions = {}
- Default value argv: string[] = process.argv
Returns ParsedCliCommand

Static start

start(programDefinition: CliProgramDefinition, version?: string, cliOptions?: CliOptions, argv?: string[]): Promise<CliRunResult>

- Defined in src/Cli.ts:9
Parameters
- programDefinition: CliProgramDefinition
- Optional version: string
- Default value cliOptions: CliOptions = {}
- Default value argv: string[] = process.argv
Returns Promise<CliRunResult>

Generated using TypeDoc