Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CompilationErrorRecoverable

A compilation error from which recovery can happen without template or software changes. This happens when a required variable is not provided in the compilation data. If this variable can be added to the compilation data, the error will be resolved.

If a compilation fails due only to recoverable errors, the IDs of the missing variables can be extracted and used to request action by the user or another system.

Hierarchy

Index

Properties

error

error: string

A message describing the compilation error.

missingIdentifier

missingIdentifier: string

The variable ID of the variable which – if provided in the compilation data – would resolve this error.

owningEntity

owningEntity: string

The ID of the entity which owns the variable referenced by missingIdentifier.

range

range: Range

The range in the source text to which this error can be traced. This is useful for highlighting/underlining the cause of the error in development.

Generated using TypeDoc