Type Alias FormatterFlags

The formatter flags.

type FormatterFlags = {
    clusterPrefix?: string;
    optionFilter?: ReadonlyArray<string>;
    positionalMarker?: string | [string, string];
    programName?: string;
    stdinSymbol?: string;
}

Properties

clusterPrefix?: string

The cluster argument prefix. If not present, cluster letters will not appear in usage statements.

optionFilter?: ReadonlyArray<string>

The option filter. If not present, all options will be included respecting the order of their definitions.

positionalMarker?: string | [string, string]

The marker(s) to delimit positional arguments (e.g. '--'). If not present, no marker will appear in usage statements.

programName?: string

The program name. If not present or empty, usage statements will contain no program name.

stdinSymbol?: string

The symbol for the standard input (e.g., '-'). If not present, the standard input will not appear in usage statements.