Class ChildrenHolderNodeAbstract

An interface for nodes that can hold children.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

children name

Methods

addChild clone nodeTree nodeTreeChildren nodeTreeHeading toBBCode toString

Constructors

constructor

Properties

children

children: BaseNode[] = []

The children of the node.

Ref: ChildrenHolder.children

Abstract name

name: string

The name of the node.

Methods

addChild

  • addChild(child): void

  • Adds a child to the node. If the node is a TextNode, attempts to flatten the node with a previous TextNode.

    Parameters

    Returns void

Abstract clone

nodeTree

  • nodeTree(indentWidth?): string

  • Converts the node into a tree-like overview of all children.

    Parameters

    • indentWidth: number = 2

      The number of spaces to indent the output. Defaults to 2.

    Returns string

    The tree-like overview of all children.

Protected nodeTreeChildren

  • nodeTreeChildren(indentWidth): string

  • Gets the children of the node tree.

    Parameters

    • indentWidth: number

      The number of spaces to indent the output.

    Returns string

    The children of the node tree.

Protected Abstract nodeTreeHeading

toBBCode

Abstract toString

  • toString(): string

  • Converts the node into a textual representation of the node as BBCode. A node should return the exact same string as the input to Parser.parse provided indented is false.

    Returns string

    The textual representation of the node as BBCode.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc