Class TreeReportNodeBuilder

TreeReportNode Builder

Build a TreeReportNode from parsed DetailedSummaries.

Hierarchy

TreeReportNodeBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new TreeReportNodeBuilder(rootPath?: string): TreeReportNodeBuilder

- Defined in classes/builders/treeReportNodeBuilder.ts:43
Construct a TreeReportNodeBuilder

Parameters
- Default value rootPath: string = ""
  
  the root path for this node - all children contain this root in their paths
Returns TreeReportNodeBuilder

Methods

addChildNode

addChildNode(child: TreeReportNode): void

- Defined in classes/builders/treeReportNodeBuilder.ts:132
Add TreeReportNode as child

Parameters
- child: TreeReportNode
  
  TreeReportNode to add as child
Returns void

addChildSummary

addChildSummary(child: DetailedSummary): void

- Defined in classes/builders/treeReportNodeBuilder.ts:88
Add DetailedSummary as child

Parameters
- child: DetailedSummary
  
  Summary to add as child
Returns void

build

build(): TreeReportNode

- Defined in classes/builders/treeReportNodeBuilder.ts:64
Build a TreeReportNode

Use the parsed data to build a TreeReportNode. If at least one child node or summary has not been added, this method will throw an error.

throws

when builder has not received at least one child

Returns TreeReportNode

TreeReportNode containing parsed data

Generated using TypeDoc