Class YargBuilderTopLevel

Hierarchy

YargBuilderTopLevel

Implements

YargBuilder

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new YargBuilderTopLevel(opts: object): YargBuilderTopLevel

- Defined in lib/cli/invocation/command/support/yargBuilder/freshYargBuilder.ts:42
Parameters
- opts: object
  - Optional epilogForHelpMessage?: string
Returns YargBuilderTopLevel

Properties

epilogsForHelpMessage

epilogsForHelpMessage: string[]

nestedCommands

nestedCommands: YargCommand[] = []

parameters

parameters: CommandLineParameter[] = []

Methods

build

build(): Built

Implementation of YargBuilder.build
- Defined in lib/cli/invocation/command/support/yargBuilder/freshYargBuilder.ts:83
Returns Built

command

command(params: SupportedSubsetOfYargsCommandMethod): this

Implementation of YargBuilder.command
- Defined in lib/cli/invocation/command/support/yargBuilder/freshYargBuilder.ts:54
Parameters
- params: SupportedSubsetOfYargsCommandMethod
Returns this

demandCommand

demandCommand(): this

Implementation of YargBuilder.demandCommand
- Defined in lib/cli/invocation/command/support/yargBuilder/freshYargBuilder.ts:48
Returns this

option

option(parameterName: string, opts: ParameterOptions): YargBuilder

Implementation of YargBuilder.option
- Defined in lib/cli/invocation/command/support/yargBuilder/freshYargBuilder.ts:74
Parameters
- parameterName: string
- opts: ParameterOptions
Returns YargBuilder

withParameter

withParameter(p: CommandLineParameter): this

Implementation of YargBuilder.withParameter
- Defined in lib/cli/invocation/command/support/yargBuilder/freshYargBuilder.ts:60
Parameters
- p: CommandLineParameter
Returns this

withSubcommand

withSubcommand(c: YargCommand | SupportedSubsetOfYargsCommandMethod): this

Implementation of YargBuilder.withSubcommand
- Defined in lib/cli/invocation/command/support/yargBuilder/freshYargBuilder.ts:65
Parameters
- c: YargCommand | SupportedSubsetOfYargsCommandMethod
Returns this

Generated using TypeDoc