Class DefaultDocumentUpdateHandler

Shared service for handling text document changes and watching relevant files.

Implements

DocumentUpdateHandler

Index

Constructors

Properties

documentBuilder onWatchedFilesChangeEmitter serviceRegistry workspaceLock workspaceManager

Accessors

onWatchedFilesChange

Methods

didChangeContent didChangeWatchedFiles fireDocumentUpdate getWatchers registerFileWatcher

Constructors

constructor

new DefaultDocumentUpdateHandler(
services: LangiumSharedServices,
): DefaultDocumentUpdateHandler
Parameters
- services: LangiumSharedServices
Returns DefaultDocumentUpdateHandler
- Defined in packages/langium/src/lsp/document-update-handler.ts:86

Properties

`Protected` `Readonly`documentBuilder

documentBuilder: DocumentBuilder

`Protected` `Readonly`onWatchedFilesChangeEmitter

onWatchedFilesChangeEmitter: Emitter<DidChangeWatchedFilesParams> = ...

`Protected` `Readonly`serviceRegistry

serviceRegistry: ServiceRegistry

`Protected` `Readonly`workspaceLock

workspaceLock: WorkspaceLock

`Protected` `Readonly`workspaceManager

workspaceManager: WorkspaceManager

Accessors

onWatchedFilesChange

get onWatchedFilesChange(): Event<DidChangeWatchedFilesParams>
Register a listener for raw file system changes. Which changes are actually reported depends on the file system watcher configuration.

Returns Event<DidChangeWatchedFilesParams>
Implementation of DocumentUpdateHandler.onWatchedFilesChange
- Defined in packages/langium/src/lsp/document-update-handler.ts:152

Methods

didChangeContent

didChangeContent(change: TextDocumentChangeEvent<TextDocument>): void
A content change event was triggered by the TextDocuments service.
Parameters
- change: TextDocumentChangeEvent<TextDocument>
Returns void
Implementation of DocumentUpdateHandler.didChangeContent
- Defined in packages/langium/src/lsp/document-update-handler.ts:133

didChangeWatchedFiles

didChangeWatchedFiles(params: DidChangeWatchedFilesParams): void
The client detected changes to files and folders watched by the language client.
Parameters
- params: DidChangeWatchedFilesParams
  The files/folders change event.
Returns void
Implementation of DocumentUpdateHandler.didChangeWatchedFiles
- Defined in packages/langium/src/lsp/document-update-handler.ts:137

`Protected`fireDocumentUpdate

fireDocumentUpdate(changed: URI[], deleted: URI[]): void
Parameters
- changed: URI[]
- deleted: URI[]
Returns void
- Defined in packages/langium/src/lsp/document-update-handler.ts:122

`Protected`getWatchers

getWatchers(): FileSystemWatcher[]
Returns FileSystemWatcher[]
- Defined in packages/langium/src/lsp/document-update-handler.ts:113

`Protected`registerFileWatcher

registerFileWatcher(services: LangiumSharedServices): void
Parameters
- services: LangiumSharedServices
Returns void
- Defined in packages/langium/src/lsp/document-update-handler.ts:104