Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractCommandYargs

Abstract Yargs Bright Command - Contains base methods for defining commands and groups

Hierarchy

Index

Constructors

constructor

Properties

Protected log

log: Logger = Logger.getImperativeLogger()

Private mCommandLine

mCommandLine: string

The command line.

memberof

AbstractCommandYargs

Private mCommandResponseParms

mCommandResponseParms: ICommandResponseParms

Command response parameters - controls command response processing when help and command handlers are invoked

Private mDefinition

mDefinition: ICommandDefinition

The command definition document

Private mEnvVariablePrefix

mEnvVariablePrefix: string

Environmental variable name prefix used to construct configuration environmental variables.

memberof

AbstractCommandYargs

Private mHelpGeneratorFactory

mHelpGeneratorFactory: IHelpGeneratorFactory

The help generator factory for creating help generators for the commands

Private mParent

The Yargs parent object - used to obtain parent handlers.

Private mProfileManagerFactory

Profile manager factory (for creating managers of certain types)

memberof

AbstractCommandYargs

Private mPromptPhrase

mPromptPhrase: string

Prompt phrase which indicates the user would like to be prompted for an argument's value with a hidden text prompt

memberof

AbstractCommandYargs

Private mRootCommandName

mRootCommandName: string

The root command name for the CLI.

memberof

AbstractCommandYargs

Private mYargsInstance

mYargsInstance: Argv

The Yargs instance to define the command.

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 profileManagerFactory

Protected promptPhrase

  • get promptPhrase(): string

Protected responseParms

Protected rootCommandName

  • get rootCommandName(): string

yargs

  • get yargs(): Argv

Methods

constructDefinitionTree

Abstract defineCommandToYargs

Protected executeHelp

Protected executeWebHelp

Protected getBrightYargsResponse

Protected getDepthExamples

Generated using TypeDoc