Class Node

A BBCode node. This represents a tag and it's children.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

attributes children name value?

Methods

addChild clone makeOpeningTag nodeTree nodeTreeChildren nodeTreeHeading setAttribute setValue toBBCode toString

Constructors

constructor

Properties

attributes

attributes: AttributeType

The attributes of the tag.

Ref: AttributeType

children

children: BaseNode[] = []

The children of the node.

Ref: ChildrenHolder.children

name

name: string

The name of the tag.

Example

`[b]Hello World![/b]` -> `b`

Optional value

value?: string

The value of the tag.

Ref: ValueHolder.value

Methods

addChild

clone

makeOpeningTag

  • makeOpeningTag(): string

  • Makes the opening tag of the node. This will include the name, and all attributes.

    Returns string

    The opening tag of the node.

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 nodeTreeHeading

setAttribute

setValue

toBBCode

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