Imperative Yargs parameters - used to define imperative commands to Yargs and provides guidance/parameters for how response objects should be handled when yargs invokes the handlers.

export
interface

  IYargsParms

### Hierarchy

- IYargsParms

## Index

### Properties

- commandDefinition
- commandLine
- commandResponseParms
- envVariablePrefix
- experimentalCommandDescription
- helpGeneratorFactory
- promptPhrase
- rootCommandName
- yargsInstance
- yargsParent

## Properties

### commandDefinition

commandDefinition: ICommandDefinition

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

The command definition document.

memberof

  IYargsParms

### commandLine

commandLine: string

- Defined in @zowe/imperative/src/cmd/src/yargs/doc/IYargsParms.ts:68

The command line.

memberof

  IYargsParms

### commandResponseParms

commandResponseParms: ICommandResponseParms

- Defined in @zowe/imperative/src/cmd/src/yargs/doc/IYargsParms.ts:43

The command response parameters normally scraped from the Imperative configuration document.

memberof

  IYargsParms

### envVariablePrefix

envVariablePrefix: string

- Defined in @zowe/imperative/src/cmd/src/yargs/doc/IYargsParms.ts:74

Environmental variable name prefix used to construct configuration environmental variables.

memberof

  IYargsParms

### experimentalCommandDescription

experimentalCommandDescription: string

- Defined in @zowe/imperative/src/cmd/src/yargs/doc/IYargsParms.ts:56

Optionally override the experimental command help text block. Used to propagate the user's configuration down to different yargs/cmd services.

memberof

  IYargsParms

### helpGeneratorFactory

helpGeneratorFactory: IHelpGeneratorFactory

- Defined in @zowe/imperative/src/cmd/src/yargs/doc/IYargsParms.ts:49

The help generator factory to be used in this CLI help generation

memberof

  IYargsParms

### promptPhrase

promptPhrase: string

- Defined in @zowe/imperative/src/cmd/src/yargs/doc/IYargsParms.ts:86

The phrase used to indicate the user wants to enter the value of an argument in a hidden text prompt

memberof

  IYargsParms

### rootCommandName

rootCommandName: string

- Defined in @zowe/imperative/src/cmd/src/yargs/doc/IYargsParms.ts:62

Root command name of the CLI.

memberof

  IYargsParms

### yargsInstance

yargsInstance: Argv

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

The instance of Yargs to define the commands.

memberof

  IYargsParms

### Optional yargsParent

yargsParent: GroupCommandYargs

- Defined in @zowe/imperative/src/cmd/src/yargs/doc/IYargsParms.ts:80

The Yargs Parent object - only has meaning for nested/group commands.

memberof

  IYargsParms

Generated using TypeDoc