Class Parser

Hierarchy

Parser

Index

Constructors

constructor

Properties

Accessors

parsedCommand

Methods

Constructors

constructor

new Parser(argv?: string[], commandPackageDefinition: CliProgramDefinition, runHandler: CliParsedCommandHandler, errorHandler: CliParsedCommandHandler, promptHandler: CliPromptHandler, version: string | undefined, internalOptions?: CliCommandDefinitionOption[], showPrompts?: boolean): Parser

- Defined in src/Parser.ts:32
Parameters
- Default value argv: string[] = process.argv
- commandPackageDefinition: CliProgramDefinition
- runHandler: CliParsedCommandHandler
- errorHandler: CliParsedCommandHandler
- promptHandler: CliPromptHandler
- version: string | undefined
- Default value internalOptions: CliCommandDefinitionOption[] = []
- Default value showPrompts: boolean = false
Returns Parser

Properties

Private _argVals

_argVals: string[] = []

Private _commandPackage

_commandPackage: CliProgram

Private _definitionOptions

_definitionOptions: CliCommandDefinitionOption[]

Private _definitionsMap

_definitionsMap: Map<string, CliCommandDefinition> = new Map()

Private _optionVals

_optionVals:

Type declaration

[name: string]: CliValue

Private _parsedCommand

_parsedCommand: Partial<ParsedCliCommand>

Private _parserErrors

_parserErrors: ParserErrors = new ParserErrors()

Private _passedOptions

_passedOptions: string[] = []

Private argv

argv: string[]

Private errorHandler

errorHandler: CliParsedCommandHandler

Private internalOptions

internalOptions: CliCommandDefinitionOption[]

Private promptHandler

promptHandler: CliPromptHandler

Private runHandler

runHandler: CliParsedCommandHandler

Private showPrompts

showPrompts: boolean

Private version

version: string | undefined

Accessors

parsedCommand

get parsedCommand(): ParsedCliCommand

- Defined in src/Parser.ts:302
Returns ParsedCliCommand

Methods

Private findCommandDefinition

findCommandDefinition(name: string): CliCommandDefinition

- Defined in src/Parser.ts:51
Parameters
- name: string
Returns CliCommandDefinition

Private getEnv

getEnv():

- Defined in src/Parser.ts:286
Returns
- [name: string]: string

Private getParsedOptionCommandName

getParsedOptionCommandName(): string

- Defined in src/Parser.ts:316
Returns string

Private parseArgs

parseArgs(): void

- Defined in src/Parser.ts:127
Returns void

Private parseArgsAndOptions

parseArgsAndOptions(): void

- Defined in src/Parser.ts:295
Returns void

Private parseCommandLine

parseCommandLine(): void

- Defined in src/Parser.ts:64
Returns void

Private parseOptions

parseOptions(): void

- Defined in src/Parser.ts:210
Returns void

Private promptArgsToArgVals

promptArgsToArgVals(promptArgs: object): string[]

- Defined in src/Parser.ts:329
Parameters
- promptArgs: object
Returns string[]

Private pushError

pushError(type: ParserErrorType, message: string): void

- Defined in src/Parser.ts:282
Parameters
- type: ParserErrorType
- message: string
Returns void

Private runAndParsePrompt

runAndParsePrompt(): Promise<void>

- Defined in src/Parser.ts:348
Returns Promise<void>

Private runner

runner(): Promise<CliRunResult>

- Defined in src/Parser.ts:365
Returns Promise<CliRunResult>

Private setProcessEnvFromParsedCommand

setProcessEnvFromParsedCommand(): void

- Defined in src/Parser.ts:323
Returns void

Generated using TypeDoc