Interface DiagnosticCollection

Readonly name

clear

• clear(): void

• Remove all diagnostics from this collection. The same as calling #set(undefined);

  Returns void

delete

• delete(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

• dispose(): void

• Dispose and free associated resources. Calls clear.

  Returns void

forEach

• forEach(callback, thisArg?): void

• Iterate over each entry in this collection.

  Parameters

  • callback: ((uri, diagnostics, collection) => any)

    Function to execute for each entry.

    • • (uri, diagnostics, collection): any

      • Parameters

        • uri: Uri
        • diagnostics: readonly Diagnostic[]
        • collection: DiagnosticCollection

        Returns any

  • Optional thisArg: any

    The this context used when invoking the handler function.

  Returns void

get

• get(uri): undefined | readonly Diagnostic[]

• 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

• has(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.

set

• set(uri, diagnostics): void

• 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
• set(entries): 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