Class RootNode

The root node that represents the head of the AST. It only stores children.

Hierarchy (view full)

ChildrenHolderNode
- RootNode
  - ListItemNode

Index

Constructors

Properties

Methods

addChild clone nodeTree nodeTreeChildren nodeTreeHeading toBBCode toString

Constructors

constructor

new RootNode(children?): RootNode
Create a new RootNode.
Parameters
- children: BaseNode[] = []
  The children of the node.
Returns RootNode
Overrides ChildrenHolderNode.constructor
- Defined in node.ts:350

Properties

children

children: BaseNode[]

The children of the node.

Ref: ChildrenHolder.children

name

name: string = "RootNode"

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
- child: BaseNode
  The child to add.
Returns void
Overrides ChildrenHolderNode.addChild
- Defined in node.ts:355

clone

clone(): RootNode
Clones the code, creating a new deep-copied node.

Returns RootNode
Overrides ChildrenHolderNode.clone
- Defined in node.ts:368

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.
Inherited from ChildrenHolderNode.nodeTree
- Defined in node.ts:62

`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.
Inherited from ChildrenHolderNode.nodeTreeChildren
- Defined in node.ts:181

`Protected` nodeTreeHeading

nodeTreeHeading(): string
Gets the heading of the node tree.

Returns string
The heading of the node tree.
Overrides ChildrenHolderNode.nodeTreeHeading
- Defined in node.ts:380

toBBCode

toBBCode(): string
Gets the textual representation of the node as BBCode. An alias for BaseNode.toString.

Returns string
Inherited from ChildrenHolderNode.toBBCode
- Defined in node.ts:53

toString

toString(): string
The textual representation of the BBCode AST. It should return a string equivalent to the input to Parser.parse.

Returns string
Overrides ChildrenHolderNode.toString
- Defined in node.ts:375

Generated using TypeDoc