Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YargsDefiner

Imperative Command Definer - Defines the Imperative command objects to Yargs for processing.

Hierarchy

  • YargsDefiner

Index

Constructors

Properties

Methods

Constructors

constructor

  • new YargsDefiner(yargsInstance: Argv, primaryHighlightColor: string, rootCommandName: string, commandLine: string, envVariablePrefix: string, helpGeneratorFactory: IHelpGeneratorFactory, experimentalCommandDescription: string, promptPhrase: string): YargsDefiner

  • Build the definer - maintains the Yargs instance for all future definitions.

    Parameters

    • yargsInstance: Argv
    • primaryHighlightColor: string

      main color to highlight help text headings and other text with

    • rootCommandName: string

      the display name of the root command (e.g. "zowe" or "sample-cli")

    • commandLine: string
    • envVariablePrefix: string

      the environment variable prefix

    • helpGeneratorFactory: IHelpGeneratorFactory

      help generator factory that can be used to instantiate new help generators

    • experimentalCommandDescription: string

      optionally overridden experimental command description to propagate to yargs services

    • promptPhrase: string

    Returns YargsDefiner

Properties

Private log

log: Logger = Logger.getImperativeLogger()

Logger instance

Private mCommandLine

mCommandLine: string

Private mEnvVariablePrefix

mEnvVariablePrefix: string

Private mExperimentalCommandDescription

mExperimentalCommandDescription: string

Private mHelpFactory

mHelpFactory: IHelpGeneratorFactory

Private mPrimaryHighlightColor

mPrimaryHighlightColor: string

Private mPromptPhrase

mPromptPhrase: string

Private mRootCommandName

mRootCommandName: string

Private mYargsInstance

mYargsInstance: Argv

The Yargs instance object used to define the commands.

Methods

define

Generated using TypeDoc