tsargp
    Preparing search index...

    Type Alias ParsingFlags

    The parsing flags.

    type ParsingFlags = {
        clusterPrefix?: string;
        completionIndex?: number;
        format?: typeof format;
        optionPrefix?: string;
        positionalMarker?: string | [string, string];
        programName?: string;
        similarity?: number;
        stdinSymbol?: string;
    }
    Index

    Properties

    clusterPrefix? completionIndex? format? optionPrefix? positionalMarker? programName? similarity? stdinSymbol?

    Properties

    clusterPrefix?: string

    The prefix of cluster arguments. If set, then eligible arguments that have this prefix will be considered a cluster. Has precedence over ParsingFlags.optionPrefix.

    completionIndex?: number

    The completion index of a raw command line.

    format?: typeof format

    The formatting function for help messages. Use the format function. (Injection is necessary for tree-shaking of the formatter component.)

    optionPrefix?: string

    The prefix of option names. If set, then arguments that have this prefix will always be considered an option name.

    positionalMarker?: string | [string, string]

    The marker(s) to delimit positional arguments (e.g. '--'). If set, then all arguments appearing after/within the marker(s) will be considered positional. Should not conflict with an option name or include an equals sign.

    programName?: string

    The program name. It may be changed by the parser.

    similarity?: number

    The similarity threshold for option name suggestions in case of an unknown option error. Values are given in percentage (e.g., 0.6). Zero or NaN means disabled.

    NaN
    stdinSymbol?: string

    The symbol for the standard input (e.g., '-') to display in usage statements. If not present, the standard input will not appear in usage statements. Should not conflict with an option name.

    Settings

    Member Visibility

    On This Page

    Properties