Type Alias WithSectionKind<T>

WithSectionKind: {
    breaks?: number;
    noWrap?: true;
    style?: Style;
    title?: string;
    type: T;
}

Defines attributes common to all help sections.

Type Parameters

  • T extends string

Type declaration

  • Optional Readonlybreaks?: number

    The number of line breaks to insert before the section. (Defaults to 0 for the first section, 1 for others)

  • Optional ReadonlynoWrap?: true

    True to disable wrapping of the provided text or headings.

  • Optional Readonlystyle?: Style

    The style of the section heading or option group headings. (Defaults to tf.bold)

  • Optional Readonlytitle?: string

    The section heading or default group heading. May contain inline styles.

  • Readonlytype: T

    The kind of section.