Class YargCommandWord

This command might be runnable by itself, and might also have subcommands.

It can be constructed whole, or built up yargs-style.

Hierarchy

YargCommandWord

Implements

YargCommand

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new YargCommandWord(spec: YargCommandWordSpec): YargCommandWord

- Defined in lib/cli/invocation/command/support/yargBuilder/sentences.ts:65
Parameters
- spec: YargCommandWordSpec
Returns YargCommandWord

Properties

commandName

commandName: string

conflictResolution

conflictResolution: ConflictResolution

description

description: string

nestedCommands

nestedCommands: YargCommand[]

Optional runnableCommand

runnableCommand: YargRunnableCommandSpec = undefined

warnings

warnings: string[]

Accessors

handleInstructions

get handleInstructions(): HandleInstructions

- Defined in lib/cli/invocation/command/support/yargBuilder/sentences.ts:193
Returns HandleInstructions

isRunnable

get isRunnable(): boolean

- Defined in lib/cli/invocation/command/support/yargBuilder/sentences.ts:139
if true, this command has a handler function if false, there are only subcommands

Returns boolean

Methods

addHelpMessages

addHelpMessages(strs: string[]): void

Implementation of YargCommand.addHelpMessages
- Defined in lib/cli/invocation/command/support/yargBuilder/sentences.ts:92
Parameters
- strs: string[]
Returns void

beRunnable

beRunnable(): void

- Defined in lib/cli/invocation/command/support/yargBuilder/sentences.ts:123
Returns void

build

build(): Built

Implementation of YargCommand.build
- Defined in lib/cli/invocation/command/support/yargBuilder/sentences.ts:143
Returns Built

command

command(params: SupportedSubsetOfYargsCommandMethod): this

Implementation of YargCommand.command
- Defined in lib/cli/invocation/command/support/yargBuilder/sentences.ts:111
Parameters
- params: SupportedSubsetOfYargsCommandMethod
Returns this

demandCommand

demandCommand(): this

Implementation of YargCommand.demandCommand
- Defined in lib/cli/invocation/command/support/yargBuilder/sentences.ts:105
Returns this

option

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

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

withParameter

withParameter(p: CommandLineParameter): this

Implementation of YargCommand.withParameter
- Defined in lib/cli/invocation/command/support/yargBuilder/sentences.ts:117
Parameters
- p: CommandLineParameter
Returns this

withSubcommand

withSubcommand(c: YargCommand | SupportedSubsetOfYargsCommandMethod): this

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

Generated using TypeDoc