Skip to content

antlr-ng Tool Class Hierarchy / index / Issue

Class: Issue ​

A class that knows how to render an issue to a string.

Constructors ​

Constructor ​

ts
new Issue(
   code, 
   formatOptions, 
   params, 
   verbose): Issue;

Parameters ​

code ​

IssueCode

formatOptions ​

IToolMessageOptions

params ​

IIssueParams

verbose ​

boolean = false

Returns ​

Issue

Properties ​

code ​

ts
readonly code: IssueCode;

Accessors ​

paramsAsString ​

Get Signature ​

ts
get paramsAsString(): string;

For testing only.

Returns ​

string

A string representation of the parameters used to create this issue.


severity ​

Get Signature ​

ts
get severity(): IssueSeverity;
Returns ​

IssueSeverity

Methods ​

toString() ​

ts
toString(): string;

Returns ​

string


fromIssue() ​

ts
static fromIssue(issue): Issue;

Parameters ​

issue ​

Issue

Returns ​

Issue