Interface Heading

A heading for a section in the usage, created by the jack.heading() method.

First heading is always level 1, subsequent headings default to 2.

The level of the nearest heading level sets the indentation of the description that follows.

interface Heading {
    left?: "";
    level: number;
    pre?: boolean;
    skipLine?: boolean;
    text: string;
    type: "heading";
}

Hierarchy (view full)

Properties

left?: ""
level: number
pre?: boolean
skipLine?: boolean
text: string
type: "heading"