BaseDiagnostic<TYPE extends AnyECType, ARGS extends any[]> Class

Deprecated  Moved to the ecschema-editing package.

Beta  

The abstract base class for all IDiagnostic implementations.

Extended by

Implements

Methods

Name Description
constructor<TYPE extends AnyECType, ARGS extends any[]>(ecDefinition: TYPE, messageArgs?: ARGS, category: DiagnosticCategory = DiagnosticCategory.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 AbstractReadOnly string Gets the unique string identifier for the diagnostic in the format ':'.  
diagnosticType Accessor AbstractReadOnly DiagnosticType Gets the context type of the diagnostic (schema, schema item, property, etc...)  
ecDefinition TYPE The EC object to associate with the diagnostic.  
messageArgs undefined | ARGS The arguments used when formatting the diagnostic message.  
messageText Accessor AbstractReadOnly string Gets the message associated with the diagnostic.  
schema Accessor AbstractReadOnly Schema Gets the schema where the diagnostic originated.  

Defined in

Last Updated: 12 June, 2024