Interface ObjectDeclarationOption

interface ObjectDeclarationOption {
    help: (i18n: TranslationProxy) => string;
    name: string;
    type: Object;
    configFileOnly?: boolean;
    defaultValue?: unknown;
    validate?: (value: unknown, i18n: TranslationProxy) => void;
}

Hierarchy (View Summary)

Properties

help name type configFileOnly? defaultValue? validate?

Properties

help

help: (i18n: TranslationProxy) => string

The help text to be displayed to the user when --help is passed.

This may be a string, which will be presented directly, or a function, which will be called with an TranslationProxy so that option help can be translated into the user specified locale.

name

name: string

The option name.

type

type: Object

The parameter type, used to convert user configuration values into the expected type. If not set, the type will be a string.

OptionalconfigFileOnly

configFileOnly?: boolean

If set, this option will be omitted from --help, and attempting to specify it on the command line will produce an error.

OptionaldefaultValue

defaultValue?: unknown

If not specified defaults to undefined.

Optionalvalidate

validate?: (value: unknown, i18n: TranslationProxy) => void

An optional validation function that validates a potential value of this option. The function must throw an Error if the validation fails and should do nothing otherwise.

Settings

Member Visibility

On This Page

Properties