Type Alias DiagnosticPullOptions

Type declaration

• OptionalonChange?: boolean

  Whether to pull for diagnostics on document change.

• OptionalonFocus?: boolean

  Whether to pull for diagnostics on editor focus.

• OptionalonSave?: boolean

  Whether to pull for diagnostics on document save.

• OptionalonTabs?: boolean

  Whether to pull for diagnostics on resources of non instantiated tabs. If it is set to true it is highly recommended to provide a match method as well. Otherwise the client will not pull for tabs if the used document selector specifies a language property since the language value is not known for resources.

• filter?:function

  • filter(document: TextDocument, mode: DiagnosticPullMode): boolean

  • An optional filter method that is consulted when triggering a diagnostic pull during document change, document save or editor focus.

    The document gets filtered if the method returns true.

    Parameters

    • document: TextDocument

      The document that changed or got saved.
    • mode: DiagnosticPullMode

      The pull mode.

    Returns boolean

    whether the document should be filtered (true) or not.

• match?:function

  • match(documentSelector: DocumentSelector, resource: Uri): boolean

  • An optional match method that is consulted when pulling for diagnostics when only a URI is known (e.g. for not instantiated tabs)

    The method should return true if the document selector matches the given resource. See also the vscode.languages.match function.

    Parameters

    • documentSelector: DocumentSelector

      The document selector.
    • resource: Uri

      The resource.

    Returns boolean

    whether the resource is matched by the given document selector.