Interface CliEnvVariableInformation<NAME, BLOCK>

Generic information about a CLI environment variable.

Type Parameters

  • NAME = string

  • BLOCK = string

Hierarchy

  • CliEnvVariableInformation

Properties

block censor? default? defaultValue? description example? legacyNames? name required? supportedValues?

Properties

block

block: BLOCK

The ENV variable block.

Optional censor

censor?: boolean

Censor variable per default to prevent leaks.

Optional default

default?: string | ((configDir: string) => string)

The default value.

Optional defaultValue

defaultValue?: string | ((configDir: string) => string)

The default value for example to display relative paths in 'default' but use absolute path as 'defaultValue'.

description

description: string

The description of the environment variable.

Optional example

example?: string

Usage example.

Optional legacyNames

legacyNames?: string[]

Legacy names of ENV variable.

name

name: NAME

The name of the environment variable.

Optional required

required?: boolean

Is required to run the program.

Optional supportedValues

supportedValues?: CliEnvVariableInformationSupportedValues

The supported values.

Settings

Member Visibility

Theme

Generated using TypeDoc