External module "lib/cli/invocation/command/support/yargBuilder/combining"

Index

Interfaces

ValidationError

Functions

Functions

checkChoicesForUniqueness

checkChoicesForUniqueness(promptableCommands: YargCommand[]): [YargCommand[], YargCommand[]]

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:181
Parameters
- promptableCommands: YargCommand[]
Returns [YargCommand[], YargCommand[]]

combine

combine(commandName: string, yss: YargCommand[]): BuildYargs

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:110
Parameters
- commandName: string
- yss: YargCommand[]
Returns BuildYargs

combineChoicesIntoRunnableCommand

combineChoicesIntoRunnableCommand(promptableCommands: YargCommand[]): YargRunnableCommandSpec

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:197
Parameters
- promptableCommands: YargCommand[]
Returns YargRunnableCommandSpec

combineIntoPrompt

combineIntoPrompt(ycs: YargCommand[]): [YargCommand[], string[]]

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:157
Parameters
- ycs: YargCommand[]
Returns [YargCommand[], string[]]

constructPromptCommandFrom

constructPromptCommandFrom(promptableCommands: YargCommand[]): YargCommand

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:186
Parameters
- promptableCommands: YargCommand[]
Returns YargCommand

contributeOnlyHelpMessages

contributeOnlyHelpMessages(formerCommandName: string, ms: string[]): BuildYargs

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:224
Parameters
- formerCommandName: string
- ms: string[]
Returns BuildYargs

describeConflictingCommand

describeConflictingCommand(yc: YargCommand): string

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:80
Parameters
- yc: YargCommand
Returns string

descriptionForConflictWarning

descriptionForConflictWarning(ysc: YargCommand): string

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:46
Parameters
- ysc: YargCommand
Returns string

dropNonessentialCommands

dropNonessentialCommands(yss: YargCommand[]): [YargCommand[], string[]]

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:88
Parameters
- yss: YargCommand[]
Returns [YargCommand[], string[]]

errorToString

errorToString(ve: ValidationError): string

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:50
Parameters
- ve: ValidationError
Returns string

promptAndRun

promptAndRun(runnableOnes: YargCommandWord[]): HandleInstructions

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:208
Parameters
- runnableOnes: YargCommandWord[]
Returns HandleInstructions

thereIsConflict

thereIsConflict(yss: YargCommand[]): boolean

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:84
Parameters
- yss: YargCommand[]
Returns boolean

warningsFromDuplicateChoices

warningsFromDuplicateChoices(duplicatedChoices: YargCommand[]): string[]

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:173
Parameters
- duplicatedChoices: YargCommand[]
Returns string[]

whyNotCombine

whyNotCombine(yss: YargCommand[]): ValidationError[]

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:60
Can we combine all of these commands into one, as they are, would it be a problem?

Parameters
- yss: YargCommand[]
Returns ValidationError[]

wrapChildren

wrapChildren(yc: YargCommandWord): YargCommandWord

- Defined in lib/cli/invocation/command/support/yargBuilder/combining.ts:100
Parameters
- yc: YargCommandWord
Returns YargCommandWord

Generated using TypeDoc