Interface DocumentSymbolProvider

getSymbols

• getSymbols(
      document: LangiumDocument,
      params: DocumentSymbolParams,
      cancelToken?: Cancellation.CancellationToken,
  ): MaybePromise<DocumentSymbol[]>

  Handle a document symbols request.

  Parameters

  • document: LangiumDocument

    The document in the workspace.
  • params: DocumentSymbolParams

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

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

  Returns MaybePromise<DocumentSymbol[]>

  The symbols for the given document.

  Throws

  OperationCancelled if cancellation is detected during execution

  Throws

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