Interface: ApplicationConfiguration
Configuration for controlling the runtime behavior of the application.
Properties
completion
readonlycompletion:CompletionConfiguration
If supplied, customizes command completion proposal behavior.
See documentation of inner types for default values.
Defined in
packages/core/src/config.ts:233
determineExitCode()?
readonlyoptionaldetermineExitCode: (exc) =>number
In the case where a command function throws some value unexpectedly or safely returns an Error, this function will translate that into an exit code.
If unspecified, the exit code will default to 1 when a command function throws some value.
Parameters
• exc: unknown
Returns
number
Defined in
packages/core/src/config.ts:246
documentation
readonlydocumentation:DocumentationConfiguration
If supplied, customizes the formatting of documentation lines in help text.
See documentation of inner types for default values.
Defined in
packages/core/src/config.ts:227
localization
readonlylocalization:LocalizationConfiguration
If supplied, customizes text localization.
See documentation of inner types for default values.
Defined in
packages/core/src/config.ts:239
name
readonlyname:string
Unique name for this application. It should match the command that is used to run the application.
Defined in
packages/core/src/config.ts:207
scanner
readonlyscanner:ScannerConfiguration
If supplied, customizes the command/argument scanning behavior of the application.
See documentation of inner types for default values.
Defined in
packages/core/src/config.ts:221
versionInfo?
readonlyoptionalversionInfo:VersionInfo
If supplied, application will be aware of version info at runtime.
Before every run, the application will fetch the latest version and warn if it differs from the current version.
As well, a new flag --version (with alias -v) will be available on the base route, which will print the current
version to stdout.