BARGS
    Preparing search index...

    Interface StringOption

    String option definition.

    interface StringOption {
        aliases?: string[];
        default?: string;
        description?: string;
        group?: string;
        hidden?: boolean;
        required?: boolean;
        type: "string";
    }

    Hierarchy

    • OptionBase
      • StringOption
    Index

    Properties

    aliases? default? description? group? hidden? required? type

    Properties

    aliases?: string[]

    Short or long aliases for this option.

    • Single-character aliases (e.g., 'v') become short flags (-v)
    • Multi-character aliases (e.g., 'verb') become long flags (--verb)
    opt.boolean({ aliases: ['v', 'verb'] }); // -v, --verb, --verbose
    default?: string
    description?: string

    Option description displayed in help text

    group?: string

    Group name for help text organization

    hidden?: boolean

    Whether this option is hidden from help

    required?: boolean

    Whether this option is required

    type: "string"

    Settings

    Member Visibility

    On This Page

    Properties