Class TextNode

A node that represents a chunk of text. This node is not a tag.

Hierarchy (view full)

BaseNode
- TextNode

Index

Constructors

Properties

Methods

clone nodeTree nodeTreeChildren nodeTreeHeading toBBCode toString

Constructors

constructor

new TextNode(text): TextNode
Create a new TextNode.
Parameters
- text: string
  The text of the node.
Returns TextNode
Overrides BaseNode.constructor
- Defined in node.ts:315

Properties

`Readonly` name

name: "TextNode" = "TextNode"

The name of the node.

text

text: string

The text of the node.

Methods

clone

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

Returns TextNode
Overrides BaseNode.clone
- Defined in node.ts:320

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 BaseNode.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.
Overrides BaseNode.nodeTreeChildren
- Defined in node.ts:333

`Protected` nodeTreeHeading

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

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

toBBCode

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

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

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.
Overrides BaseNode.toString
- Defined in node.ts:324

Generated using TypeDoc