Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TreeReportNode

Tree Report Node

An extension of {@link Summary | Summary} that also includes a set of child TreeReportNodes or DetailedSummarys to create a tree-like structure. This is used by the {@link TreeReport | TreeReport} to build a hierarchy that matches a directory structure for a set of paths.

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new TreeReportNode(path: string, name: string, branch: Record, func: Record, line: Record, childPaths?: string[], children?: undefined | object): TreeReportNode

  • Construct a Tree Report Node

    Parameters

    • path: string

      path associated with summary data

    • name: string

      name associated with summary data

    • branch: Record

      Record for branch data to store

    • func: Record

      Record for function data to store

    • line: Record

      Record for line data to store

    • Optional childPaths: string[]

      Descendents of this node

    • Optional children: undefined | object

      Child nodes of this node

    Returns TreeReportNode

Accessors

branch

childPaths

  • get childPaths(): string[]

children

  • get children(): object

function

line

name

  • get name(): string

path

  • get path(): string

Methods

clone

combine

Generated using TypeDoc