Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TableOfContents

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TableOfContents(name: string, title?: string, depth?: number, tabLeader?: string): TableOfContents
  • Parameters

    • name: string

      The name for this element.

    • Optional title: string

      Title of the table of contents. Optional.

    • Optional depth: number

      The depth of heading to be shown, 3 by default. Optional.

    • Optional tabLeader: string

      How the space between title and page number should be filled. Can be "hyphen", "underscore", or "dot" (default). Optional.

    Returns TableOfContents

Properties

depth

depth: undefined | number

name

name: string

tabLeader

tabLeader: undefined | string

title

title: undefined | string

Methods

asDict

  • asDict(): {}

availableTags

  • availableTags(): Set<string>

Generated using TypeDoc