Class BaseNode`Abstract`

The abstract base class for all nodes.

Hierarchy (view full)

BaseNode
- ChildrenHolderNode
- TextNode

Index

Constructors

Properties

Methods

clone nodeTree nodeTreeChildren nodeTreeHeading toBBCode toString

Constructors

constructor

new BaseNode(): BaseNode
Returns BaseNode

Properties

`Abstract` name

name: string

The name of the node.

Methods

`Abstract` clone

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

Returns BaseNode
- Defined in node.ts:40

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.
- Defined in node.ts:62

`Protected` `Abstract` 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.
- Defined in node.ts:77

`Protected` `Abstract` nodeTreeHeading

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

Returns string
The heading of the node tree.
- Defined in node.ts:70

toBBCode

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

Returns string
- Defined in node.ts:53

`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.
- Defined in node.ts:47

Generated using TypeDoc