Interface SkeletonItem

interface SkeletonItem {
    depth?: number;
    endLine: number;
    kind: SkeletonKind;
    startLine: number;
    title?: string;
}

Index

Properties

depth? endLine kind startLine title?

Properties

`Optional`depth

depth?: number

Heading depth (1 for h1, 2 for top-level sections).

endLine

endLine: number

kind

kind: SkeletonKind

startLine

startLine: number

1-based inclusive line range of the region.

`Optional`title

title?: string

Heading text for h1/section/see-also/notes/references items.