Interface DocumentHighlightProvider

getDocumentHighlight

• getDocumentHighlight(
      document: LangiumDocument,
      params: DocumentHighlightParams,
      cancelToken?: Cancellation.CancellationToken,
  ): MaybePromise<undefined | DocumentHighlight[]>

  Handle a document highlight request.

  Parameters

  • document: LangiumDocument

    The document in which the request was received.
  • params: DocumentHighlightParams

    The parameters of the document highlight request.
  • OptionalcancelToken: Cancellation.CancellationToken

    A cancellation token that can be used to cancel the request.

  Returns MaybePromise<undefined | DocumentHighlight[]>

  The document highlights or undefined if no highlights are available.

  Throws

  OperationCancelled if cancellation is detected during execution

  Throws

  ResponseError if an error is detected that should be sent as response to the client