Type Alias WithEnv

WithEnv: { break?: true; sources?: ReadonlyArray<string | URL>; stdin?: true }

Defines attributes for options that may read data from the environment.

Type declaration

  • Optional Readonlybreak?: true

    True to break the parsing loop after parsing the option.

  • Optional Readonlysources?: ReadonlyArray<string | URL>

    The names of environment data sources to try reading from (in that order), if the option is specified neither on the command-line nor in the standard input. A string means an environment variable, while a URL means a local file.

  • Optional Readonlystdin?: true

    True to read data from the standard input, if the option is not specified in the command-line. This has precedence over WithEnv.sources.

Settings

Member Visibility