TypeDoc API - v0.28.2

    Interface FlagsDeclarationOption<T>

    interface FlagsDeclarationOption<T extends Record<string, boolean>> {
        defaults: T;
        help: () => string;
        name: string;
        type: Flags;
        configFileOnly?: boolean;
    }

    Type Parameters

    • T extends Record<string, boolean>

    Hierarchy (View Summary, Expand)

    Index

    Properties

    defaults help name type configFileOnly?

    Properties

    defaults: T

    All of the possible flags, with their default values set.

    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: Flags

    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.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR