Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentHighlightProvider

A document highlight provider provides ranges to highlight in the current document like all occurrences of a variable or all exit-points of a function.

Providers are queried for document highlights on symbol hovers in any document matching the document selector specified at registration time.

Hierarchy

  • DocumentHighlightProvider

Index

Methods

provideDocumentHighlights

  • Provide document highlights for the given position and document.

    Parameters

    • document: TextDocument

      The document in which the command was invoked.

    • position: Position

      The position at which the command was invoked.

    Returns ProviderResult<DocumentHighlight[]>

    An array of document highlights, or a thenable that resolves to document highlights. The lack of a result can be signaled by returning undefined, null, or an empty array.

Generated using TypeDoc