Command response control parameters. Indicates how the command response should behave and allows influence over colorings, etc.

export
interface

  ICommandResponseParms

### Hierarchy

- ICommandResponseParms

## Index

### Properties

- args
- definition
- primaryTextColor
- progressBarSpinner
- responseFormat
- silent
- stream

## Properties

### Optional args

args: Arguments

- Defined in @zowe/imperative/src/cmd/src/doc/response/parms/ICommandResponseParms.ts:36

The arguments specified on the command line

memberof

  ICommandResponseParms

### Optional definition

definition: ICommandDefinition

- Defined in @zowe/imperative/src/cmd/src/doc/response/parms/ICommandResponseParms.ts:42

The command definition for this response

memberof

  ICommandResponseParms

### Optional primaryTextColor

primaryTextColor: string

- Defined in @zowe/imperative/src/cmd/src/doc/response/parms/ICommandResponseParms.ts:48

The primary text color used by Chalk package for highlighting messages.

memberof

  ICommandResponseParms

### Optional progressBarSpinner

progressBarSpinner: string

- Defined in @zowe/imperative/src/cmd/src/doc/response/parms/ICommandResponseParms.ts:67

The Progress bar spinner characters.

memberof

  ICommandResponseParms

### Optional responseFormat

responseFormat: COMMAND_RESPONSE_FORMAT

- Defined in @zowe/imperative/src/cmd/src/doc/response/parms/ICommandResponseParms.ts:61

The response format for the command. Controls how output is generated for the command (ignored if silent is specified). See the type for more details.

memberof

  ICommandResponseParms

### Optional silent

silent: boolean

- Defined in @zowe/imperative/src/cmd/src/doc/response/parms/ICommandResponseParms.ts:54

Silent indicates that the command should produce absolutely no output to stdout/stderr (the console/terminal)

memberof

  ICommandResponseParms

### Optional stream

stream: any

- Defined in @zowe/imperative/src/cmd/src/doc/response/parms/ICommandResponseParms.ts:29

Stream

memberof

  ICommandResponseParms

Generated using TypeDoc