Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TOC

Hierarchy

  • TOC

Index

Constructors

Properties

Methods

Constructors

constructor

  • Table of Contents. Represents an array of TOC items + some useful methods.

    Parameters

    • Default value items: TOCItem[] = []

    Returns TOC

Properties

items

items: TOCItem[]

Methods

addItem

  • Add TOC item to the TOC array as long as it isn't a duplicate. Returns true if successfully added (no duplicate) otherwise false.

    Parameters

    Returns boolean

getItem

  • getItem(group: string, name: string): TOCItem
  • Gets an item by its group + name. Returns null if no item exists.

    Parameters

    • group: string
    • name: string

    Returns TOCItem

getItemById

  • Returns TOC item with a certain id. Returns null if no item exists.

    Parameters

    • id: number

    Returns TOCItem

Generated using TypeDoc