asciidoctor
    Preparing search index...

    Type Alias OptionDefinition

    Definition of a CLI option used by Options#addOption.

    type OptionDefinition = {
        default?: string | boolean;
        describe?: string;
        metavar?: string;
        multiple?: boolean;
        short?: string;
        type: "string" | "boolean";
    }
    Index

    Properties

    default? describe? metavar? multiple? short? type

    Properties

    default?: string | boolean
    • default value when the option is absent
    describe?: string
    • description shown in --help output
    metavar?: string
    • value placeholder shown in --help for string options (e.g. <theme>)
    multiple?: boolean
    • whether the option can be repeated
    short?: string
    • single character short alias (without -)
    type: "string" | "boolean"
    • the value type of the option

    Settings

    Member Visibility

    On This Page

    Properties