Class Diagnostic

Informational message attached to an input location.

Hierarchy

Diagnostic

Implements

Display

Constructors

constructor

new Diagnostic(input, tag, severity, message, note, cause): Diagnostic
Parameters
- input: Input
- tag: Tag
- severity: Severity
- message: string
- note: string
- cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:12

Properties

`Readonly` cause

cause: Diagnostic

The Diagnostic cause of this diagnostic, forming a linked chain of diagnostics, or null if this diagnostic has no cause.

`Private` lineDigits

lineDigits: any

`Readonly` message

message: string

The help message that describes this diagnostic.

`Readonly` note

note: string

An informative comment on the source context to which this diagnostic is attached.

`Readonly` severity

severity: Severity

The level of importance of this diagnostic.

`Readonly` tag

tag: Tag

The location in the input to which this diagnostic is attached.

`Private` `Static` consumeLineText

consumeLineText: any

`Private` `Static` display

display: any

`Private` `Static` displayAnchor

displayAnchor: any

`Private` `Static` displayContext

displayContext: any

`Private` `Static` displayEndLine

displayEndLine: any

`Private` `Static` displayLine

displayLine: any

`Private` `Static` displayLineComment

displayLineComment: any

`Private` `Static` displayLineLead

displayLineLead: any

`Private` `Static` displayLineLeadArrow

displayLineLeadArrow: any

`Private` `Static` displayLineLeadComment

displayLineLeadComment: any

`Private` `Static` displayLineLeadEllipsis

displayLineLeadEllipsis: any

`Private` `Static` displayLineLeadNumber

displayLineLeadNumber: any

`Private` `Static` displayLineText

displayLineText: any

`Private` `Static` displayLines

displayLines: any

`Private` `Static` displayMidLine

displayMidLine: any

`Private` `Static` displayNote

displayNote: any

`Private` `Static` displaySingleLine

displaySingleLine: any

`Private` `Static` displayStartLine

displayStartLine: any

`Private` `Static` formatSeverity

formatSeverity: any

Methods

display

display<T>(output): Output<T>
Writes a human readable, display-formatted string representation of this object to output.
Type Parameters
- T
Parameters
- output: Output<T>
Returns Output<T>
the continuation of the output.

Throws
[[OutputException]] if the output exits the cont state before the full display string has been written.
Implementation of Display.display
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:37

toString

toString(settings?): string
Parameters
- Optional settings: OutputSettings
Returns string
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:59

`Static` create

create(input, tag, severity, cause?): Diagnostic
Parameters
- input: Input
- tag: Tag
- severity: Severity
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:60
create(input, tag, severity, message, cause?): Diagnostic
Parameters
- input: Input
- tag: Tag
- severity: Severity
- message: string
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:61
create(input, tag, severity, message, note, cause?): Diagnostic
Parameters
- input: Input
- tag: Tag
- severity: Severity
- message: string
- note: string
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:62

`Static` expected

expected(expected, input, cause?): Diagnostic
Parameters
- expected: string | number
- input: Input
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:71
expected(expected, input, note, cause?): Diagnostic
Parameters
- expected: string | number
- input: Input
- note: string
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:72
expected(expected, input, severity, cause?): Diagnostic
Parameters
- expected: string | number
- input: Input
- severity: Severity
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:73
expected(expected, input, severity?, note?, cause?): Diagnostic
Parameters
- expected: string | number
- input: Input
- Optional severity: Severity
- Optional note: string
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:74

`Static` message

message(message, input, cause?): Diagnostic
Parameters
- message: string
- input: Input
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:63
message(message, input, note, cause?): Diagnostic
Parameters
- message: string
- input: Input
- note: string
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:64
message(message, input, severity, cause?): Diagnostic
Parameters
- message: string
- input: Input
- severity: Severity
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:65
message(message, input, severity?, note?, cause?): Diagnostic
Parameters
- message: string
- input: Input
- Optional severity: Severity
- Optional note: string
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:66

`Static` unexpected

unexpected(input, cause?): Diagnostic
Parameters
- input: Input
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:67
unexpected(input, note, cause?): Diagnostic
Parameters
- input: Input
- note: string
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:68
unexpected(input, severity, cause?): Diagnostic
Parameters
- input: Input
- severity: Severity
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:69
unexpected(input, severity?, note?, cause?): Diagnostic
Parameters
- input: Input
- Optional severity: Severity
- Optional note: string
- Optional cause: Diagnostic
Returns Diagnostic
- Defined in swim-core/swim-codec/lib/main/source/Diagnostic.d.ts:70

Class Diagnostic

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

input: Input

tag: Tag

severity: Severity

message: string

note: string

cause: Diagnostic

Returns Diagnostic

Properties

Readonly cause

Private lineDigits

Readonly message

Readonly note

Readonly severity

Readonly tag

Private Static consumeLineText

Private Static display

Private Static displayAnchor

Private Static displayContext

Private Static displayEndLine

Private Static displayLine

Private Static displayLineComment

Private Static displayLineLead

Private Static displayLineLeadArrow

Private Static displayLineLeadComment

Private Static displayLineLeadEllipsis

Private Static displayLineLeadNumber

Private Static displayLineText

Private Static displayLines

Private Static displayMidLine

Private Static displayNote

Private Static displaySingleLine

Private Static displayStartLine

Private Static formatSeverity

Methods

display

Type Parameters

T

Parameters

output: Output<T>

Returns Output<T>

Throws

toString

Parameters

Optional settings: OutputSettings

Returns string

Static create

Parameters

input: Input

tag: Tag

severity: Severity

Optional cause: Diagnostic

Returns Diagnostic

Parameters

input: Input

tag: Tag

severity: Severity

message: string

Optional cause: Diagnostic

Returns Diagnostic

Parameters

input: Input

tag: Tag

severity: Severity

message: string

note: string

Optional cause: Diagnostic

Returns Diagnostic

Static expected

Parameters

expected: string | number

`Readonly` cause

`Private` lineDigits

`Readonly` message

`Readonly` note

`Readonly` severity

`Readonly` tag

`Private` `Static` consumeLineText

`Private` `Static` display

`Private` `Static` displayAnchor

`Private` `Static` displayContext

`Private` `Static` displayEndLine

`Private` `Static` displayLine

`Private` `Static` displayLineComment

`Private` `Static` displayLineLead

`Private` `Static` displayLineLeadArrow

`Private` `Static` displayLineLeadComment

`Private` `Static` displayLineLeadEllipsis

`Private` `Static` displayLineLeadNumber

`Private` `Static` displayLineText

`Private` `Static` displayLines

`Private` `Static` displayMidLine

`Private` `Static` displayNote

`Private` `Static` displaySingleLine

`Private` `Static` displayStartLine

`Private` `Static` formatSeverity

`Optional` settings: OutputSettings

`Static` create

`Optional` cause: Diagnostic

`Optional` cause: Diagnostic

`Optional` cause: Diagnostic

`Static` expected

`Optional` cause: Diagnostic

`Optional` cause: Diagnostic

`Optional` cause: Diagnostic

`Optional` severity: Severity

`Optional` note: string

`Optional` cause: Diagnostic

`Static` message

`Optional` cause: Diagnostic

`Optional` cause: Diagnostic

`Optional` cause: Diagnostic

`Optional` severity: Severity

`Optional` note: string

`Optional` cause: Diagnostic

`Static` unexpected

`Optional` cause: Diagnostic

`Optional` cause: Diagnostic

`Optional` cause: Diagnostic

`Optional` severity: Severity

`Optional` note: string

`Optional` cause: Diagnostic