Class NormalizedTextDocuments<T>

Normalizing text document manager. Normalizes all incoming URIs to the same format used by VS Code.

Type Parameters

T extends { uri: string }

Implements

TextDocuments<T>

Index

Constructors

constructor

new NormalizedTextDocuments<T extends { uri: string }>(
configuration: TextDocumentsConfiguration<T>,
): NormalizedTextDocuments<T>
Type Parameters
- T extends { uri: string }
Parameters
- configuration: TextDocumentsConfiguration<T>
Returns NormalizedTextDocuments<T>
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:136

Accessors

onDidChangeContent

get onDidChangeContent(): Event<TextDocumentChangeEvent<T>>
An event that fires when a text document managed by this manager has been opened or the content changes.

Returns Event<TextDocumentChangeEvent<T>>
Implementation of TextDocuments.onDidChangeContent
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:151

onDidClose

get onDidClose(): Event<TextDocumentChangeEvent<T>>
An event that fires when a text document managed by this manager has been closed.

Returns Event<TextDocumentChangeEvent<T>>
Implementation of TextDocuments.onDidClose
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:167

onDidOpen

get onDidOpen(): Event<TextDocumentChangeEvent<T>>
An event that fires when a text document managed by this manager has been opened.

Returns Event<TextDocumentChangeEvent<T>>
Implementation of TextDocuments.onDidOpen
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:147

onDidSave

get onDidSave(): Event<TextDocumentChangeEvent<T>>
An event that fires when a text document managed by this manager has been saved.

Returns Event<TextDocumentChangeEvent<T>>
Implementation of TextDocuments.onDidSave
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:163

onWillSave

get onWillSave(): Event<TextDocumentWillSaveEvent<T>>
An event that fires when a text document managed by this manager will be saved.

Returns Event<TextDocumentWillSaveEvent<T>>
Implementation of TextDocuments.onWillSave
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:155

Methods

all

all(): T[]
Returns all text documents managed by this instance.

Returns T[]
all text documents.
Implementation of TextDocuments.all
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:197

delete

delete(uri: string | URI | T): void
Deletes a text document managed by this instance.
Parameters
- uri: string | URI | T
Returns void
Implementation of TextDocuments.delete
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:188

get

get(uri: string | URI): undefined | T
Returns the document for the given URI. Returns undefined if the document is not managed by this instance.
Parameters
- uri: string | URI
  The text document's URI to retrieve.
Returns undefined | T
the text document or undefined.
Implementation of TextDocuments.get
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:171

keys

keys(): string[]
Returns the URIs of all text documents managed by this instance.

Returns string[]
the URI's of all text documents.
Implementation of TextDocuments.keys
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:201

listen

listen(connection: Connection): Disposable
Listens for low level notification on the given connection to update the text documents managed by this instance.

Please note that the connection only provides handlers not an event model. Therefore listening on a connection will overwrite the following handlers on a connection: onDidOpenTextDocument, onDidChangeTextDocument, onDidCloseTextDocument, onWillSaveTextDocument, onWillSaveTextDocumentWaitUntil and onDidSaveTextDocument.

Use the corresponding events on the TextDocuments instance instead.
Parameters
- connection: Connection
  The connection to listen on.
Returns Disposable
Implementation of TextDocuments.listen
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:205

onWillSaveWaitUntil

onWillSaveWaitUntil(
handler: RequestHandler<TextDocumentWillSaveEvent<T>, TextEdit[], void>,
): void
Sets a handler that will be called if a participant wants to provide edits during a text document save.
Parameters
- handler: RequestHandler<TextDocumentWillSaveEvent<T>, TextEdit[], void>
Returns void
Implementation of TextDocuments.onWillSaveWaitUntil
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:159

set

set(document: T): boolean
Sets the text document managed by this instance.
Parameters
- document: T
  The text document to add.
Returns boolean
true if the document didn't exist yet, false if it was already present.
Implementation of TextDocuments.set
- Defined in packages/langium/src/lsp/normalized-text-documents.ts:175

Class NormalizedTextDocuments<T>

Type Parameters

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NormalizedTextDocuments<T>

Accessors

onDidChangeContent

Returns Event<TextDocumentChangeEvent<T>>

onDidClose

Returns Event<TextDocumentChangeEvent<T>>

onDidOpen

Returns Event<TextDocumentChangeEvent<T>>

onDidSave

Returns Event<TextDocumentChangeEvent<T>>

onWillSave

Returns Event<TextDocumentWillSaveEvent<T>>

Methods

all

Returns T[]

delete

Parameters

Returns void

get

Parameters

Returns undefined | T

keys

Returns string[]

listen

Parameters

Returns Disposable

onWillSaveWaitUntil

Parameters

Returns void

set

Parameters

Returns boolean

Settings

On This Page