Class Node

Represents a Node in the Treegen structure.

Hierarchy

Node

Index

Constructors

Properties

children name nodeType tree

Accessors

Methods

addChild buildTree genIndent printTree

Constructors

constructor

new Node(name, nodeType?): Node
Constructor for the Node class.
Parameters
- name: string
  
  The name of the Node.
- nodeType: NodeType = 'any'
  
  The type of the Node.
Returns Node
- Defined in Node.ts:19

Properties

children

children: Node[] = []

name

name: string

The name of the Node.

nodeType

nodeType: NodeType = 'any'

The type of the Node.

`Private` tree

tree: string = ''

Accessors

getTree

get getTree(): string
Get the generated tree.

Must be called after Node.buildTree

Returns string
- Defined in Node.ts:28

Methods

addChild

addChild(child): void
Add a child Node to the current Node.
Parameters
- child: Node
  
  The child Node to add.
Returns void
- Defined in Node.ts:37

buildTree

buildTree(options?): void
Build the tree structure starting from the current Node.
Parameters
- options: IBuildTreeOptions = {}
  
  Options for building the tree.
Returns void
- Defined in Node.ts:65

`Private` genIndent

genIndent(level, treeIndent): string
Generate the indentation for the tree structure.
Parameters
- level: number
  
  The level of indentation.
- treeIndent: string
  
  The tree indent characters.
Returns string
The generated indentation.
- Defined in Node.ts:48

printTree

printTree(options?): void
Print the generated tree structure to the console or a file.
Parameters
- options: IPrintTreeOptions = {}
  
  Options for printing the tree.
Returns void
- Defined in Node.ts:109

Generated using TypeDoc