Home Manual Reference Source Test Repository
public class | source

AnalyzeError

Provides a wrapper for analysis errors stored in the errors array for each report type.

Static Method Summary

Static Public Methods
public static

Deserializes a JSON object representing a AnalyzeError.

Constructor Summary

Public Constructor
public

Initializes an instance.

Member Summary

Public Members
public

Provides the line number where the error starts.

public

Provides the line number where the error starts.

public

Provides the error message.

public

name: *

Attempt to find the name then try srcPath for modules.

public

Provides the severity level.

public

Provides a type of report where the error is found.

Method Summary

Public Methods
public

Returns a verbose string about the error.

Static Public Methods

public static parse(object: object): AnalyzeError source

Deserializes a JSON object representing a AnalyzeError.

Params:

NameTypeAttributeDescription
object object

A JSON object of a AnalyzeError that was previously serialized.

Return:

AnalyzeError

Public Constructors

public constructor(severity: string, message: string, sourceReport: ClassMethodReport | ClassReport | ModuleMethodReport | ModuleReport | ProjectReport) source

Initializes an instance.

Params:

NameTypeAttributeDescription
severity string

Provides the severity level.

message string

Provides the error message.

sourceReport ClassMethodReport | ClassReport | ModuleMethodReport | ModuleReport | ProjectReport

The source report of the error.

Public Members

public lineEnd: number source

Provides the line number where the error starts.

public lineStart: number source

Provides the line number where the error starts.

public message: string source

Provides the error message.

public name: * source

Attempt to find the name then try srcPath for modules.

public severity: string source

Provides the severity level.

public type: string source

Provides a type of report where the error is found.

Public Methods

public toString(): string source

Returns a verbose string about the error.

Return:

string