BARGS
    Preparing search index...

    Interface ArrayOption

    Array option definition (--flag value --flag value2).

    interface ArrayOption {
        aliases?: string[];
        default?: number[] | string[];
        description?: string;
        group?: string;
        hidden?: boolean;
        items?: "string" | "number";
        required?: boolean;
        type: "array";
    }

    Hierarchy

    • OptionBase
      • ArrayOption
    Index

    Properties

    aliases? default? description? group? hidden? items? 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?: number[] | 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

    items?: "string" | "number"

    Element type of the array (for primitive arrays)

    required?: boolean

    Whether this option is required

    type: "array"

    Settings

    Member Visibility

    On This Page

    Properties