Diagnostic | Swim Toolkit

Hierarchy

Diagnostic

Implements

Display

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Diagnostic(input: Input, tag: Tag, severity: Severity, message: undefined | string, note: undefined | string, cause: null | Diagnostic): Diagnostic

- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:7
Parameters
- input: Input
- tag: Tag
- severity: Severity
- message: undefined | string
- note: undefined | string
- cause: null | Diagnostic
Returns Diagnostic

Properties

Readonly cause

cause: null | Diagnostic

Readonly input

input: Input

Readonly message

message: undefined | string

Readonly note

note: undefined | string

Readonly severity

severity: Severity

Readonly tag

tag: Tag

Methods

display

display(output: Output<unknown>): void

Implementation of Display.display
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:16
Parameters
- output: Output<unknown>
Returns void

toString

toString(settings?: OutputSettings): string

- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:17
Parameters
- Optional settings: OutputSettings
Returns string

Static create

create(input: Input, tag: Tag, severity: Severity, cause?: null | Diagnostic): Diagnostic
create(input: Input, tag: Tag, severity: Severity, message: undefined | string, cause?: null | Diagnostic): Diagnostic
create(input: Input, tag: Tag, severity: Severity, message: undefined | string, note: undefined | string, cause?: null | Diagnostic): Diagnostic

- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:18
Parameters
- input: Input
- tag: Tag
- severity: Severity
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:19
Parameters
- input: Input
- tag: Tag
- severity: Severity
- message: undefined | string
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:20
Parameters
- input: Input
- tag: Tag
- severity: Severity
- message: undefined | string
- note: undefined | string
- Optional cause: null | Diagnostic
Returns Diagnostic

Static displayMessage

displayMessage(severity: Severity, message: undefined | string, output: Output<unknown>): void

- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:34
Parameters
- severity: Severity
- message: undefined | string
- output: Output<unknown>
Returns void

Static expected

expected(expected: string | number, input: Input, cause?: null | Diagnostic): Diagnostic
expected(expected: string | number, input: Input, note: string, cause?: null | Diagnostic): Diagnostic
expected(expected: string | number, input: Input, severity: Severity, cause?: null | Diagnostic): Diagnostic
expected(expected: string | number, input: Input, severity?: Severity, note?: string, cause?: null | Diagnostic): Diagnostic

- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:29
Parameters
- expected: string | number
- input: Input
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:30
Parameters
- expected: string | number
- input: Input
- note: string
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:31
Parameters
- expected: string | number
- input: Input
- severity: Severity
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:32
Parameters
- expected: string | number
- input: Input
- Optional severity: Severity
- Optional note: string
- Optional cause: null | Diagnostic
Returns Diagnostic

Static message

message(message: string, input: Input, cause?: null | Diagnostic): Diagnostic
message(message: string, input: Input, note: string, cause?: null | Diagnostic): Diagnostic
message(message: string, input: Input, severity: Severity, cause?: null | Diagnostic): Diagnostic
message(message: string, input: Input, severity?: Severity, note?: string, cause?: null | Diagnostic): Diagnostic

- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:21
Parameters
- message: string
- input: Input
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:22
Parameters
- message: string
- input: Input
- note: string
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:23
Parameters
- message: string
- input: Input
- severity: Severity
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:24
Parameters
- message: string
- input: Input
- Optional severity: Severity
- Optional note: string
- Optional cause: null | Diagnostic
Returns Diagnostic

Static unexpected

unexpected(input: Input, cause?: null | Diagnostic): Diagnostic
unexpected(input: Input, note: string, cause?: null | Diagnostic): Diagnostic
unexpected(input: Input, severity: Severity, cause?: null | Diagnostic): Diagnostic
unexpected(input: Input, severity?: Severity, note?: string, cause?: null | Diagnostic): Diagnostic

- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:25
Parameters
- input: Input
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:26
Parameters
- input: Input
- note: string
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:27
Parameters
- input: Input
- severity: Severity
- Optional cause: null | Diagnostic
Returns Diagnostic
- Defined in swim-system-js/swim-core-js/@swim/codec/lib/main/source/Diagnostic.d.ts:28
Parameters
- input: Input
- Optional severity: Severity
- Optional note: string
- Optional cause: null | Diagnostic
Returns Diagnostic

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

input: Input

tag: Tag

severity: Severity

message: undefined | string

note: undefined | string

cause: null | Diagnostic

Returns Diagnostic

Properties

Readonly cause

Readonly input

Readonly message

Readonly note

Readonly severity

Readonly tag

Methods

display

Parameters

output: Output<unknown>

Returns void

toString

Parameters

Optional settings: OutputSettings

Returns string

Static create

Parameters

input: Input

tag: Tag

severity: Severity

Optional cause: null | Diagnostic

Returns Diagnostic

Parameters

input: Input

tag: Tag

severity: Severity

message: undefined | string

Optional cause: null | Diagnostic

Returns Diagnostic

Parameters

input: Input

tag: Tag

severity: Severity

message: undefined | string

note: undefined | string

Optional cause: null | Diagnostic

Returns Diagnostic

Static displayMessage

Parameters

severity: Severity

message: undefined | string

output: Output<unknown>

Returns void

Static expected

Parameters

expected: string | number

input: Input

Optional cause: null | Diagnostic

Returns Diagnostic

Parameters

expected: string | number

input: Input

note: string

Optional cause: null | Diagnostic

Returns Diagnostic

Parameters

expected: string | number

input: Input

severity: Severity

Optional cause: null | Diagnostic

Returns Diagnostic

Parameters

expected: string | number