Gjsify LogoGjsify Logo

Hierarchy

  • Diagnostic

Index

Constructors

  • Creates a new diagnostic.

    If you want to set a range for the diagnostic, see ide_diagnostic_add_range() or ide_diagnostic_take_range().

    Parameters

    Returns Diagnostic

Properties

name: string

Methods

  • Adds the range to the diagnostic. This allows diagnostic tools to highlight the errored text appropriately.

    Parameters

    Returns void

  • This is a helper to simplify the process of determining what file the diagnostic is within. It is equivalent to getting the source location and looking at the file.

    Returns Gio.File

  • get_fixit(index: number): Fixit
  • Gets the fixit denoted by index. This value should be less than the value returned from ide_diagnostic_get_num_fixits().

    Parameters

    • index: number

      The index of the fixit.

    Returns Fixit

  • get_num_fixits(): number
  • get_num_ranges(): number
  • Retrieves the range found at index. It is a programming error to call this function with a value greater or equal to ide_diagnostic_get_num_ranges().

    Parameters

    • index: number

    Returns SourceRange

  • get_text(): string
  • get_text_for_display(): string
  • This creates a new string that is formatted using the diagnostics line number, column, severity, and message text in the format "line:column: severity: message".

    This can be convenient when wanting to quickly display a diagnostic such as in a tooltip.

    Returns string

  • hash(): number
  • take_fixit(fixit: Fixit): void
  • Adds the suggested fixit to the diagnostic while transfering ownership of fixit to self.

    Parameters

    • fixit: Fixit

      An #IdeFixit.

    Returns void

  • Steals the ownership of range and adds to the diagnostic.

    This saves multiple atomic references of range which could be expensive if you are doing lots of diagnostics.

    Parameters

    Returns void

  • unref(): void
  • Creates a new diagnostic.

    If you want to set a range for the diagnostic, see ide_diagnostic_add_range() or ide_diagnostic_take_range().

    Parameters

    Returns Diagnostic

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method