import AggregateMethodReport from 'typhonjs-escomplex-commons/src/module/report/AggregateMethodReport.js'

public class | source

AggregateMethodReport

Extends:

AbstractReport → AggregateMethodReport

Direct Subclass:

MethodReport, MethodReport

Indirect Subclass:

ClassMethodReport, ModuleMethodReport, ClassMethodReport, ModuleMethodReport

Provides the aggregate report object which stores base data pertaining to a single method / function or cumulative aggregate data for a ModuleReport / ClassReport.

Constructor Summary

Public Constructor
public	constructor(lineStart: number, lineEnd: number) Initializes aggregate report.

Member Summary

Public Members
public	cyclomatic: number The cyclomatic complexity of the method.
public	cyclomaticDensity: number The cyclomatic density of the method.
public	halstead: HalsteadData Stores the Halstead data instance.
public	params: number The number of parameters for the method or aggregate report.
public	sloc: {logical: number, physical: number} The source lines of code for the method.

Inherited Summary

From class AbstractReport
public get	aggregateMethodReport: AggregateMethodReport: * Returns the associated `AggregateMethodReport` or `this`.
public	methodAggregate: AggregateMethodReport Stores any associated `AggregateMethodReport`.
public	incrementDistinctHalsteadItems(metric: string, identifier: string) Increments the associated aggregate report HalsteadData for distinct identifiers.
public	incrementHalsteadItems(metric: string, identifier: string) Increments the associated aggregate report Halstead items including distinct and total counts.
public	incrementHalsteadMetric(metric: string, type: string) Increments the associated aggregate report Halstead metric type.
public	incrementParams(count: number) Increments the associated aggregate report parameter count.
public	isHalsteadMetricDistinct(metric: string, identifier: string): boolean Returns true if a given HalsteadData metric / identifier is not found in the associated aggregate report.
public	toFormat(name: string, options: object): string Formats this report given the type.

Public Constructors

public constructor(lineStart: number, lineEnd: number) source

Initializes aggregate report.

Override:

AbstractReport#constructor

Params:

Name	Type	Attribute	Description
lineStart	number		Start line of method.
lineEnd	number		End line of method.

Name

Type

Attribute

Description

lineStart

number

Start line of method.

lineEnd

number

End line of method.

Public Members

public cyclomatic: number source

The cyclomatic complexity of the method.

public cyclomaticDensity: number source

The cyclomatic density of the method.

public halstead: HalsteadData source

Stores the Halstead data instance.

public params: number source

The number of parameters for the method or aggregate report.

public sloc: {logical: number, physical: number} source

The source lines of code for the method.