Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

CommandLineParameter

CommandLineParameter: ParameterOptions & object

ConflictResolution

ConflictResolution: object | ResolveConflictWithPrompt

Functions

dropWithWarningsInHelp

failEverythingInCaseOfConflict

  • If more than one of this command appear, then

    • if all the others resolve with "drop with warnings," fine, this one wins
    • otherwise, fail the whole program with an error, on startup, even if they didn't want to use this command. This is the default because the others are opt-in, but you probably don't want to use it on anything dynamically added.

    Parameters

    • commandDescription: string

    Returns ConflictResolution

isPromptForChoice

isYargCommand

promptForAChoiceWhenNecessary

  • promptForAChoiceWhenNecessary(commandDescription: string, uniqueChoice: string): ConflictResolution
  • If more than one of this command appear, ask the user to choose between them. The uniqueChoice will distinguish them. If two of the same command with the same uniqueChoice conflict, or if one of the commands insists on failing everything in case of conflict, fallback to drop with warning.

    Parameters

    • commandDescription: string
    • uniqueChoice: string

    Returns ConflictResolution

Generated using TypeDoc