Options
All
  • Public
  • Public/Protected
  • All
Menu

Define an Imperative Command to Yargs. A command implies that an implementation is present (differs from a "group") and it does not have children.

Hierarchy

Index

Constructors

constructor

Properties

Protected log

log: Logger = Logger.getImperativeLogger()

Protected yargsParms

yargsParms: IYargsParms

Parameter object contains parms for Imperative/Yargs and command response objects

Static STOP_YARGS

STOP_YARGS: boolean = false

TODO: REMOVE THIS, workaround for yargs.fail() problem

Accessors

Protected commandLine

  • get commandLine(): string

definition

Protected envVariablePrefix

  • get envVariablePrefix(): string

Protected helpGeneratorFactory

parents

Protected promptPhrase

  • get promptPhrase(): string

Protected responseParms

Protected rootCommandName

  • get rootCommandName(): string

yargs

  • get yargs(): Argv

Methods

Private buildPositionalString

  • buildPositionalString(): string
  • Construct the positional argument string for Yargs. The positional arguments are always constructed as "optional" to yargs. This prevents yargs from "throwing errors" if the user requests --help and the positional parameters are not specified.

    Returns string

    : The positional argument string used in the Yargs command definition.

constructDefinitionTree

defineCommandToYargs

Protected executeHelp

Protected executeWebHelp

Protected getDepthExamples

Protected getZoweYargsResponse

Private invokeHandlers

Static defineOptionsToYargs

Generated using TypeDoc