BaseDiagnostic<TYPE extends AnyECType, ARGS extends any[]> Class
The abstract base class for all IDiagnostic implementations.
Extended by
- SchemaDiagnostic
- SchemaItemDiagnostic
- PropertyDiagnostic
- RelationshipConstraintDiagnostic
- CustomAttributeContainerDiagnostic
Implements
- IDiagnostic<TYPE, ARGS>
Methods
| Name | Description | |
|---|---|---|
| constructor<TYPE extends AnyECType, ARGS extends any[]>(ecDefinition: TYPE, messageArgs?: ARGS, category: DiagnosticCategoryDiagnosticCategory.Error): BaseDiagnostic<TYPE, ARGS> | Initializes a new BaseDiagnostic. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| category | DiagnosticCategory | The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above. | |
| code Accessor Abstract ReadOnly | string | Gets the unique string identifier for the diagnostic in the format ' |
|
| diagnosticType Accessor Abstract ReadOnly | DiagnosticType | Gets the context type of the diagnostic (schema, schema item, property, etc...) | |
| ecDefinition | TYPE | The EC object to associate with the diagnostic. | |
| messageArgs | ARGS | undefined | The arguments used when formatting the diagnostic message. | |
| messageText Accessor Abstract ReadOnly | string | Gets the message associated with the diagnostic. | |
| schema Accessor Abstract ReadOnly | Schema | Gets the schema where the diagnostic originated. |
Defined in
Last Updated: 14 November, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.