Interface DocumentHighlightProvider

provideDocumentHighlights

• provideDocumentHighlights(
      document: TextDocument,
      position: Position,
      token: undefined | CancellationToken,
  ): ProviderResult<DocumentHighlight[]>

  Provide a set of document highlights, like all occurrences of a variable or all exit-points of a function.

  Parameters

  • document: TextDocument

    The document in which the command was invoked.

  • position: Position

    The position at which the command was invoked.

  • token: undefined | CancellationToken

    A cancellation token.

  Returns ProviderResult<DocumentHighlight[]>

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