Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SupportedSubsetOfYargsCommandMethod

Hierarchy

  • SupportedSubsetOfYargsCommandMethod

Index

Properties

Properties

Optional aliases

aliases: string[] | string

Optional builder

builder: function

Type declaration

command

command: string

Optional conflictResolution

conflictResolution: ConflictResolution

Specify what to do if this command conflicts with another command built onto the same yargs. The default is to declare an error and exit, so you probably want something different. Construct with:

  • promptForAChoiceWhenNecessary (recommended)
  • dropWithWarningsInHelp (polite)
  • failEverythingInCaseOfConflict (default)

describe

describe: string

Optional handler

handler: function

Type declaration

    • (argObject: Arguments<any>): Promise<any>

    • Parameters

      • argObject: Arguments<any>

      Returns Promise<any>

Optional parameters

parameters: CommandLineParameter[]

Optional positional

positional: PositionalParameter[]

Generated using TypeDoc