TypeDoc API - v0.28.2

    Interface ObjectDeclarationOption

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

    Hierarchy (View Summary, Expand)

    Index

    Properties

    help name type configFileOnly? defaultValue? validate?

    Properties

    help: () => 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 so that option help can be translated into the user specified locale.

    name: string

    The option name.

    type: Object

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

    configFileOnly?: boolean

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

    defaultValue?: unknown

    If not specified defaults to undefined.

    validate?: (value: unknown) => 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
    MMNEPVFCICPMFPCPTTAAATR