TypeDoc API - v0.28.4

    Interface DeclarationOptionBase

    interface DeclarationOptionBase {
        help: () => string;
        name: string;
        configFileOnly?: boolean;
        type?: Configuration.ParameterType;
    }

    Hierarchy (View Summary)

    Index

    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.

    configFileOnly?: boolean

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

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

    MMNEPVFCICPMFPCPTTAAATR