Class DefaultWorkspaceSymbolProvider

Shared service for handling workspace symbols requests.

Implements

WorkspaceSymbolProvider

Index

Constructors

Properties

fuzzyMatcher indexManager nodeKindProvider

Methods

getSymbols getWorkspaceSymbol

Constructors

constructor

new DefaultWorkspaceSymbolProvider(
services: LangiumSharedServices,
): DefaultWorkspaceSymbolProvider
Parameters
- services: LangiumSharedServices
Returns DefaultWorkspaceSymbolProvider
- Defined in packages/langium/src/lsp/workspace-symbol-provider.ts:51

Properties

`Protected` `Readonly`fuzzyMatcher

fuzzyMatcher: FuzzyMatcher

`Protected` `Readonly`indexManager

indexManager: IndexManager

`Protected` `Readonly`nodeKindProvider

nodeKindProvider: NodeKindProvider

Methods

getSymbols

getSymbols(
params: WorkspaceSymbolParams,
cancelToken?: Cancellation.CancellationToken,
): Promise<WorkspaceSymbol[]>
Handle a workspace symbols request.
Parameters
- params: WorkspaceSymbolParams
  workspaces symbols request parameters
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
  a cancellation token tha can be used to cancel the request
Returns Promise<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
Implementation of WorkspaceSymbolProvider.getSymbols
- Defined in packages/langium/src/lsp/workspace-symbol-provider.ts:57

`Protected`getWorkspaceSymbol

getWorkspaceSymbol(
astDescription: AstNodeDescription,
): WorkspaceSymbol | undefined
Parameters
- astDescription: AstNodeDescription
Returns WorkspaceSymbol | undefined
- Defined in packages/langium/src/lsp/workspace-symbol-provider.ts:72