Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DiagnosticCollection

Hierarchy

  • DiagnosticCollection

Index

Properties

name: string

The name of this diagnostic collection, for instance typescript. Every diagnostic from this collection will be associated with this name. Also, the task framework uses this name when defining problem matchers.

Methods

  • clear(): void
  • delete(uri: Uri): void
  • Remove all diagnostics from this collection that belong to the provided uri. The same as #set(uri, undefined).

    Parameters

    • uri: Uri

      A resource identifier.

    Returns void

  • dispose(): void
  • Get the diagnostics for a given resource. Note that you cannot modify the diagnostics-array returned from this call.

    Parameters

    • uri: Uri

      A resource identifier.

    Returns undefined | readonly Diagnostic[]

    An immutable array of diagnostics or undefined.

  • has(uri: Uri): boolean
  • Check if this collection contains diagnostics for a given resource.

    Parameters

    • uri: Uri

      A resource identifier.

    Returns boolean

    true if this collection has diagnostic for the given resource.

  • Assign diagnostics for given resource. Will replace existing diagnostics for that resource.

    Parameters

    • uri: Uri

      A resource identifier.

    • diagnostics: undefined | Diagnostic[]

      Array of diagnostics or undefined

    Returns void

  • Replace all entries in this collection for given uris.

    Diagnostics of multiple tuples of the same uri will be merged, e.g [[file1, [d1]], [file1, [d2]]] is equivalent to [[file1, [d1, d2]]]. If a diagnostics item is undefined as in [file1, undefined] all previous but not subsequent diagnostics are removed.

    Parameters

    • entries: undefined | [Uri, undefined | Diagnostic[]][]

      An array of tuples, like [[file1, [d1, d2]], [file2, [d3, d4, d5]]], or undefined.

    Returns void