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

public class | source

ModuleMethodReport

Provides the module method report object which stores data pertaining to a single method / function.

Static Method Summary

Static Public Methods
public static	getFormats(): Object[] Returns the supported transform formats.
public static	parse(object: object): ModuleMethodReport Deserializes a JSON object representing a ModuleMethodReport.

Public Members
public get	type: ReportType: * Returns the enum for the report type.

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.

From class AggregateMethodReport
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.

From class MethodReport
protected static	_parse(targetObject: ClassMethodReport \| ModuleMethodReport, jsonObject: object): ClassMethodReport \| ModuleMethodReport Deserializes a JSON object representing a ClassMethodReport.
public	errors: Array Stores any analysis errors.
public	lineEnd: number Stores the end line for the method.
public	lineStart: number Stores the start line for the method.
public	name: string The name of the method.
public	params: number The number of parameters for the method or report.
public	clearErrors() Clears all errors stored in the method report.
public	getErrors(options: object): Array<AnalyzeError \| {error: AnalyzeError, source: *}> Gets all errors stored in the method report.
public	getName(): string Returns the name / id associated with this report.

Returns the supported transform formats.

Deserializes a JSON object representing a ModuleMethodReport.

Name	Type	Attribute	Description
object	object		A JSON object of a ModuleMethodReport that was previously serialized.

Name

Type

Attribute

Description

object

A JSON object of a ModuleMethodReport that was previously serialized.

Returns the enum for the report type.