Type alias WithHelp

WithHelp: {
    config?: FormatterConfig;
    sections?: HelpSections;
    useFilter?: true;
    useFormat?: true;
    useNested?: true;
}

Defines attributes for the help option.

Type declaration

  • Optional Readonly config?: FormatterConfig

    The formatter configuration.

  • Optional Readonly sections?: HelpSections

    The help sections to be rendered.

  • Optional Readonly useFilter?: true

    Whether to use the remaining arguments as option filter.

  • Optional Readonly useFormat?: true

    Whether to use the next argument as the name of a help format. Has precedence over WithHelp.useFilter.

  • Optional Readonly useNested?: true

    Whether to use the next argument as the name of a nested command. Has precedence over WithHelp.useFormat.