Option constants - includes static options built/added by request (on imperative config or command definitions).

export

### Hierarchy

- OptionConstants

## Index

### Properties

- RESPONSE_FORMAT_TYPES

### Object literals

- RESPONSE_FORMAT_FILTER_OPTION
- RESPONSE_FORMAT_HEADER_OPTION
- RESPONSE_FORMAT_OPTION

## Properties

### Static Readonly RESPONSE_FORMAT_TYPES

RESPONSE_FORMAT_TYPES: string[] = ["table", "list", "object", "string"]

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:60

The array of available format types (for the response-format-type definition allowable values).

static
memberof

  OptionConstants

## Object literals

### Static Readonly RESPONSE_FORMAT_FILTER_OPTION

RESPONSE_FORMAT_FILTER_OPTION: object

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:26

The response format filter options allows users to filter (include) fields/properties in an output table/object. Enable this option by specifying "outputFormatOptions: true" on your ICommandDefinition document.

static
memberof

  OptionConstants

### aliases

aliases: string[] = ["rff"]

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:28

### description

description: string = "Filter (include) fields in the response. " +"Accepts an array of field/property names to include in the output response. " +"You can filter JSON objects properties OR table columns/fields. " +"In addition, you can use this option in conjunction with '--response-format-type' " +"to reduce the output of a command to a single field/property or a list of a single field/property."

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:29

### group

group: string = "Response Format Options"

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:35

### name

name: string = "response-format-filter"

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:27

### type

type: "array" = "array"

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:34

### Static Readonly RESPONSE_FORMAT_HEADER_OPTION

RESPONSE_FORMAT_HEADER_OPTION: object

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:45

The response format header option allows users to include a table header (or not). Enable this option by specifying "outputFormatOptions: true" on your ICommandDefinition document.

static
memberof

  OptionConstants

### aliases

aliases: string[] = ["rfh"]

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:47

### defaultValue

defaultValue: null = null

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:51

### description

description: string = "If "--response-format-type table" is specified, include the column headers in the output."

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:48

### group

group: string = "Response Format Options"

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:50

### name

name: string = "response-format-header"

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:46

### type

type: "boolean" = "boolean"

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:49

### Static Readonly RESPONSE_FORMAT_OPTION

RESPONSE_FORMAT_OPTION: object

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:69

The response format type option allows users control over handler output (print/console) data format. Enable this option by specifying "outputFormatOptions: true" on your ICommandDefinition document.

static
memberof

  OptionConstants

### aliases

aliases: string[] = ["rft"]

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:71

### description

description: string = `The command response output format type. Must be one of the following:` +"\n\ntable: " +"Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. " +"Each property of the object will become a column in the table." +"\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) " +"are stringified and a new line is added after each entry in an array." +"\n\nobject: Formats output data as a list of prettified objects (or single object). " +"Can be used in place of \"table\" to change from tabular output to a list of prettified objects." +"\n\nstring: Formats output data as a string. JSON objects/arrays are stringified."

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:72

### group

group: string = "Response Format Options"

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:86

### name

name: string = "response-format-type"

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:70

### type

type: "string" = "string"

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:81

### allowableValues

allowableValues: object

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:82

### caseSensitive

caseSensitive: false = false

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:84

### values

values: string[] = OptionConstants.RESPONSE_FORMAT_TYPES

- Defined in @zowe/imperative/src/cmd/src/constants/OptionConstants.ts:83

Generated using TypeDoc