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

public class | source

MethodReport

Extends:

AbstractReport → AggregateMethodReport → MethodReport

Direct Subclass:

ClassMethodReport, ModuleMethodReport, ClassMethodReport, ModuleMethodReport

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

Static Method Summary

Static Protected Methods
protected static	_parse(targetObject: ClassMethodReport \| ModuleMethodReport, jsonObject: object): ClassMethodReport \| ModuleMethodReport Deserializes a JSON object representing a ClassMethodReport.

Constructor Summary

Public Constructor
public	constructor(name: string, lineStart: number, lineEnd: number, params: number) Initializes method report.

Member Summary

Public Members
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.

Method Summary

Public Methods
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.

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.

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.

Static Protected Methods

protected static _parse(targetObject: ClassMethodReport | ModuleMethodReport, jsonObject: object): ClassMethodReport | ModuleMethodReport source

Deserializes a JSON object representing a ClassMethodReport.

Params:

Name	Type	Attribute	Description
targetObject	ClassMethodReport \| ModuleMethodReport		A target object to hydrate.
jsonObject	object		A JSON object of a class or module method report that was previously serialized.

Name

Type

Attribute

Description

targetObject

ClassMethodReport | ModuleMethodReport

A target object to hydrate.

jsonObject

object

A JSON object of a class or module method report that was previously serialized.

Return:

ClassMethodReport | ModuleMethodReport

Public Constructors

public constructor(name: string, lineStart: number, lineEnd: number, params: number) source

Initializes method report.

Override:

AggregateMethodReport#constructor

Params:

Name	Type	Attribute	Description
name	string		Name of the method.
lineStart	number		Start line of method.
lineEnd	number		End line of method.
params	number		Number of parameters for method.

Public Members

public errors: Array source

Stores any analysis errors.

public lineEnd: number source

Stores the end line for the method.

public lineStart: number source

Stores the start line for the method.

public name: string source

The name of the method.

public params: number source

The number of parameters for the method or report.

Override:

AggregateMethodReport#params

Public Methods

public clearErrors() source

Clears all errors stored in the method report.

public getErrors(options: object): Array<AnalyzeError | {error: AnalyzeError, source: *}> source

Gets all errors stored in the method report.

Params:

Name	Type	Attribute	Description
options	object		Optional parameters.

Name

Type

Attribute

Description

options

object

Optional parameters.

Return:

Array<AnalyzeError | {error: AnalyzeError, source: *}>

Return Properties:

Name Type Attribute Description

includeChildren

Name	Type	Attribute	Description
includeChildren	boolean		If false then module errors are not included; default (true).
includeReports	boolean		If true then results will be an array of object hashes containing `source` (the source report object of the error) and `error` (an AnalyzeError instance) keys; default (false).

boolean

If false then module errors are not included; default (true).

includeReports

boolean

If true then results will be an array of object hashes containing source (the source report object of the error) and error (an AnalyzeError instance) keys; default (false).

public getName(): string source

Returns the name / id associated with this report.

Return:

string