Interface DocumentUpdateHandler

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

interface DocumentUpdateHandler {
    didChangeContent?(event: TextDocumentChangeEvent<TextDocument>): void;
    didChangeWatchedFiles?(params: DidChangeWatchedFilesParams): void;
    didCloseDocument?(event: TextDocumentChangeEvent<TextDocument>): void;
    didOpenDocument?(event: TextDocumentChangeEvent<TextDocument>): void;
    didSaveDocument?(event: TextDocumentChangeEvent<TextDocument>): void;
    willSaveDocument?(event: TextDocumentWillSaveEvent<TextDocument>): void;
    willSaveDocumentWaitUntil?(event: TextDocumentWillSaveEvent<TextDocument>): MaybePromise<TextEdit[]>;
}

Implemented by

DefaultDocumentUpdateHandler

Index

Methods

didChangeContent? didChangeWatchedFiles? didCloseDocument? didOpenDocument? didSaveDocument? willSaveDocument? willSaveDocumentWaitUntil?

Methods

`Optional`didChangeContent

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

`Optional`didChangeWatchedFiles

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

`Optional`didCloseDocument

didCloseDocument(event): void
A document close event was triggered by the TextDocuments service.
Parameters
- event: TextDocumentChangeEvent<TextDocument>
  The document change event.
Returns void
- Defined in packages/langium/src/lsp/document-update-handler.ts:59

`Optional`didOpenDocument

didOpenDocument(event): void
A document open event was triggered by the TextDocuments service.
Parameters
- event: TextDocumentChangeEvent<TextDocument>
  The document change event.
Returns void
- Defined in packages/langium/src/lsp/document-update-handler.ts:28

`Optional`didSaveDocument

didSaveDocument(event): void
A document save event (completed) was triggered by the TextDocuments service.
Parameters
- event: TextDocumentChangeEvent<TextDocument>
  The document change event.
Returns void
- Defined in packages/langium/src/lsp/document-update-handler.ts:53

`Optional`willSaveDocument

willSaveDocument(event): void
A document save event (initiated) was triggered by the TextDocuments service.
Parameters
- event: TextDocumentWillSaveEvent<TextDocument>
  The document change event.
Returns void
- Defined in packages/langium/src/lsp/document-update-handler.ts:40

`Optional`willSaveDocumentWaitUntil

willSaveDocumentWaitUntil(event): MaybePromise<TextEdit[]>
A document save event (initiated) was triggered by the TextDocuments service.
Parameters
- event: TextDocumentWillSaveEvent<TextDocument>
  The document change event.
Returns MaybePromise<TextEdit[]>
An array of text edits which will be applied to the document before it is saved.
- Defined in packages/langium/src/lsp/document-update-handler.ts:47