Interface ObjectDeclarationOption

Hierarchy

Properties

help name type configFileOnly? defaultValue? validate?

Properties

help

help: string

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

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.

Optional configFileOnly

configFileOnly?: boolean

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

Optional defaultValue

defaultValue?: unknown

If not specified defaults to undefined.

Optional validate

validate?: ((value) => void)

Type declaration

    • (value): 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.

      Parameters

      • value: unknown

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc