Type alias FormatterConfig

FormatterConfig: {
    descr?: WithColumn<Alignment | "merge"> & WithAbsolute;
    filter?: ReadonlyArray<string>;
    items?: ReadonlyArray<HelpItem>;
    names?: WithColumn<Alignment | "slot">;
    param?: WithColumn<Alignment | "merge"> & WithAbsolute;
    phrases?: Readonly<Partial<Record<HelpItem, string>>>;
}

The formatter configuration.

Type declaration

  • Optional Readonly descr?: WithColumn<Alignment | "merge"> & WithAbsolute

    The settings for the description column.

  • Optional filter?: ReadonlyArray<string>

    A list of patterns to filter options.

  • Optional Readonly items?: ReadonlyArray<HelpItem>

    The order of items to be shown in the option description.

  • Optional Readonly names?: WithColumn<Alignment | "slot">

    The settings for the names column.

  • Optional Readonly param?: WithColumn<Alignment | "merge"> & WithAbsolute

    The settings for the parameter column.

  • Optional Readonly phrases?: Readonly<Partial<Record<HelpItem, string>>>

    The phrases to be used for each kind of description item.