Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configuration

Hierarchy

  • Configuration

Index

Properties

boolean-negation

boolean-negation: boolean

Should variables prefixed with --no be treated as negations? Default is true

camel-case-expansion

camel-case-expansion: boolean

Should hyphenated arguments be expanded into camel-case aliases? Default is true

combine-arrays

combine-arrays: boolean

Should arrays be combined when provided by both command line arguments and a configuration file. Default is false

dot-notation

dot-notation: boolean

Should keys that contain . be treated as objects? Default is true

duplicate-arguments-array

duplicate-arguments-array: boolean

Should arguments be coerced into an array when duplicated. Default is true

flatten-duplicate-arrays

flatten-duplicate-arrays: boolean

Should array arguments be coerced into a single array when duplicated. Default is true

halt-at-non-option

halt-at-non-option: boolean

Should parsing stop at the first text argument? This is similar to how e.g. ssh parses its command line. Default is false

negation-prefix

negation-prefix: string

The prefix to use for negated boolean variables. Default is 'no-'

parse-numbers

parse-numbers: boolean

Should keys that look like numbers be treated as such? Default is true

populate--

populate--: boolean

Should unparsed flags be stored in -- or _. Default is false

set-placeholder-key

set-placeholder-key: boolean

Should a placeholder be added for keys not set via the corresponding CLI argument? Default is false

short-option-groups

short-option-groups: boolean

Should a group of short-options be treated as boolean flags? Default is true

strip-aliased

strip-aliased: boolean

Should aliases be removed before returning results? Default is false

strip-dashed

strip-dashed: boolean

Should dashed keys be removed before returning results? This option has no effect if camel-case-expansion is disabled. Default is false

unknown-options-as-args

unknown-options-as-args: boolean

Should unknown options be treated like regular arguments? An unknown option is one that is not configured in opts. Default is false