Service for reading environmental variable settings exposed for CLIs built on Imperative CLI framework

export

### Hierarchy

- EnvironmentalVariableSettings

## Index

### Properties

- APP_LOG_LEVEL_KEY_SUFFIX
- APP_MASK_OUTPUT_SUFFIX
- CLI_HOME_SUFFIX
- CLI_PLUGINS_DIR_SUFFIX
- ENV_REQUEST_COMPLETION_TIMEOUT_SUFFIX
- ENV_SHOW_SECURE_SUFFIX
- ENV_SOCKET_CONNECT_TIMEOUT_SUFFIX
- IMPERATIVE_LOG_LEVEL_KEY_SUFFIX
- PROMPT_PHRASE_SUFFIX

### Methods

- read

## Properties

### Static Readonly APP_LOG_LEVEL_KEY_SUFFIX

APP_LOG_LEVEL_KEY_SUFFIX: "_APP_LOG_LEVEL" = "_APP_LOG_LEVEL"

- Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:38

The end of the environmental variable for configuring the log level for the appLogger of your CLI The prefix will be added to the beginning of this value to construct the full key

memberof

  EnvironmentalVariableSettings

### Static Readonly APP_MASK_OUTPUT_SUFFIX

APP_MASK_OUTPUT_SUFFIX: "_APP_MASK_OUTPUT" = "_APP_MASK_OUTPUT"

- Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:46

The end of the environmental variable for configuring the ability to mask output of your CLI The prefix will be added to the beginning of this value to construct the full key

memberof

  EnvironmentalVariableSettings

### Static Readonly CLI_HOME_SUFFIX

CLI_HOME_SUFFIX: "_CLI_HOME" = "_CLI_HOME"

- Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:54

The end of the environmental variable for configuring the home directory for your CLI The prefix will be added to the beginning of this value to construct the full key

memberof

  EnvironmentalVariableSettings

### Static Readonly CLI_PLUGINS_DIR_SUFFIX

CLI_PLUGINS_DIR_SUFFIX: "_CLI_PLUGINS_DIR" = "_CLI_PLUGINS_DIR"

- Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:70

The end of the environmental variable for configuring the plugins directory for your CLI The prefix will be added to the beginning of this value to contruct the full key

memberof

  EnvironmentalVariableSettings

### Static Readonly ENV_REQUEST_COMPLETION_TIMEOUT_SUFFIX

ENV_REQUEST_COMPLETION_TIMEOUT_SUFFIX: "_REQUEST_COMPLETION_TIMEOUT" = "_REQUEST_COMPLETION_TIMEOUT"

- Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:91

Set the request completion timeout, in milliseconds

memberof

  EnvironmentalVariableSettings

### Static Readonly ENV_SHOW_SECURE_SUFFIX

ENV_SHOW_SECURE_SUFFIX: "_SHOW_SECURE_ARGS" = `_SHOW_SECURE_ARGS`

- Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:77

Show secure fields in the output of the command ENV var suffix

memberof

  EnvironmentalVariableSettings

### Static Readonly ENV_SOCKET_CONNECT_TIMEOUT_SUFFIX

ENV_SOCKET_CONNECT_TIMEOUT_SUFFIX: "_SOCKET_CONNECT_TIMEOUT" = "_SOCKET_CONNECT_TIMEOUT"

- Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:84

Set the socket connection timeout in milliseconds

memberof

  EnvironmentalVariableSettings

### Static Readonly IMPERATIVE_LOG_LEVEL_KEY_SUFFIX

IMPERATIVE_LOG_LEVEL_KEY_SUFFIX: "_IMPERATIVE_LOG_LEVEL" = "_IMPERATIVE_LOG_LEVEL"

- Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:30

The end of the environmental variable for configuring the log level for the imperative logger of your CLI The prefix will be added to the beginning of this value to construct the full key

memberof

  EnvironmentalVariableSettings

### Static Readonly PROMPT_PHRASE_SUFFIX

PROMPT_PHRASE_SUFFIX: "_PROMPT_PHRASE" = "_PROMPT_PHRASE"

- Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:62

The end of the environmental variable for configuring the prompt phrase for your CLI The prefix will be added to the beginning of this value to construct the full key

memberof

  EnvironmentalVariableSettings

## Methods

### Static read

- read(prefix: string): IImperativeEnvironmentalVariableSettings

- - Defined in @zowe/imperative/src/imperative/src/env/EnvironmentalVariableSettings.ts:102

  Read all environmental variable settings for a CLI

  memberof

    EnvironmentalVariableSettings

  #### Parameters

  - ##### prefix: string

    the environmental variables for a CLI will begin with this prefix e.g. "SAMPLE_CLI". by default, this should be the same as the Imperative.loadedConfig.name field unless you specify envVariablePrefix on your Imperative configuration

  #### Returns IImperativeEnvironmentalVariableSettings

  - object populated with the settings specified by the user

Generated using TypeDoc