Type Alias ParsingFlags

ParsingFlags: {
    clusterPrefix?: string;
    compIndex?: number;
    optionPrefix?: string;
    progName?: string;
    resolve?: ModuleResolutionCallback;
}

The parsing flags.

Type declaration

  • Optional ReadonlyclusterPrefix?: 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.

  • Optional ReadonlycompIndex?: number

    The completion index of a raw command line.

  • Optional ReadonlyoptionPrefix?: string

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

  • OptionalprogName?: string

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

  • Optional Readonlyresolve?: ModuleResolutionCallback

    A resolution function for JavaScript modules. Use import.meta.resolve.bind(import.meta). Use in non-browser environments only.