Interface WorkspaceSymbolProvider

Shared service for handling workspace symbols requests.

interface WorkspaceSymbolProvider {
    getSymbols(
        params: WorkspaceSymbolParams,
        cancelToken?: Cancellation.CancellationToken,
    ): MaybePromise<WorkspaceSymbol[]>;
    resolveSymbol(
        symbol: WorkspaceSymbol,
        cancelToken?: Cancellation.CancellationToken,
    ): MaybePromise<WorkspaceSymbol>;
}

Implemented by

DefaultWorkspaceSymbolProvider

Index

Methods

getSymbols resolveSymbol?

Methods

getSymbols

getSymbols(
params: WorkspaceSymbolParams,
cancelToken?: Cancellation.CancellationToken,
): MaybePromise<WorkspaceSymbol[]>
Handle a workspace symbols request.
Parameters
- params: WorkspaceSymbolParams
  workspaces symbols request parameters
- OptionalcancelToken: Cancellation.CancellationToken
  a cancellation token tha can be used to cancel the request
Returns MaybePromise<WorkspaceSymbol[]>
a list of workspace symbols

Throws
OperationCancelled if cancellation is detected during execution

Throws
ResponseError if an error is detected that should be sent as response to the client
- Defined in packages/langium/src/lsp/workspace-symbol-provider.ts:31

`Optional`resolveSymbol

resolveSymbol(
symbol: WorkspaceSymbol,
cancelToken?: Cancellation.CancellationToken,
): MaybePromise<WorkspaceSymbol>
Handle a resolve request for a workspace symbol.
Parameters
- symbol: WorkspaceSymbol
  the workspace symbol to resolve
- OptionalcancelToken: Cancellation.CancellationToken
  a cancellation token tha can be used to cancel the request
Returns MaybePromise<WorkspaceSymbol>
the resolved workspace symbol

Throws
OperationCancelled if cancellation is detected during execution

Throws
ResponseError if an error is detected that should be sent as response to the client
- Defined in packages/langium/src/lsp/workspace-symbol-provider.ts:42