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

### Hierarchy

- YargsDefiner

## Index

### Constructors

- constructor

### Properties

- log
- mCommandLine
- mEnvVariablePrefix
- mExperimentalCommandDescription
- mHelpFactory
- mPrimaryHighlightColor
- mPromptPhrase
- mRootCommandName
- mYargsInstance

### Methods

- define

## Constructors

### constructor

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

- - Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:41

  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()

- Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:41

Logger instance

### Private mCommandLine

mCommandLine: string

- Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:32

### Private mEnvVariablePrefix

mEnvVariablePrefix: string

- Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:33

### Private mExperimentalCommandDescription

mExperimentalCommandDescription: string

- Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:35

### Private mHelpFactory

mHelpFactory: IHelpGeneratorFactory

- Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:34

### Private mPrimaryHighlightColor

mPrimaryHighlightColor: string

- Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:30

### Private mPromptPhrase

mPromptPhrase: string

- Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:36

### Private mRootCommandName

mRootCommandName: string

- Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:31

### Private mYargsInstance

mYargsInstance: Argv

- Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:29

The Yargs instance object used to define the commands.

## Methods

### define

- define(definition: ICommandDefinition, commandExecuted: YargsCommandCompleted, responseParms: ICommandResponseParms): void

- - Defined in @zowe/imperative/src/cmd/src/yargs/YargsDefiner.ts:78

  Accepts an Imperative command definition document and defines to Yargs.

  #### Parameters

  - ##### definition: ICommandDefinition

  - ##### commandExecuted: YargsCommandCompleted

  - ##### responseParms: ICommandResponseParms

    The response object parameters used when invoking commands and help

  #### Returns void

Generated using TypeDoc