Interface LangiumDocuments

Readonlyall

addDocument

• addDocument(document: LangiumDocument): void

  Manage a new document under this service.

  Parameters

  • document: LangiumDocument

  Returns void

  Throws

  an error if a document with the same URI is already present.

createDocument

• createDocument(uri: URI, text: string): LangiumDocument

  Creates a new document with the given URI and text content. The new document is automatically added to this service and can be retrieved using getDocument.

  Parameters

  • uri: URI
  • text: string

  Returns LangiumDocument

  Throws

  an error if a document with the same URI is already present.

• createDocument(
      uri: URI,
      text: string,
      cancellationToken: Cancellation.CancellationToken,
  ): Promise<LangiumDocument<AstNode>>

  Creates a new document with the given URI and text content asynchronously. The process can be interrupted with a cancellation token. The new document is automatically added to this service and can be retrieved using getDocument.

  Parameters

  • uri: URI
  • text: string
  • cancellationToken: Cancellation.CancellationToken

  Returns Promise<LangiumDocument<AstNode>>

  Throws

  an error if a document with the same URI is already present.

deleteDocument

• deleteDocument(uri: URI): undefined | LangiumDocument<AstNode>

  Remove the document with the given URI, if present, and mark it as Changed, meaning that its content is no longer valid. The next call to getOrCreateDocument with the same URI will create a new document instance.

  Parameters

  • uri: URI

  Returns undefined | LangiumDocument<AstNode>

  the affected LangiumDocument if existing for convenience

deleteDocuments

• deleteDocuments(uri: URI): LangiumDocument<AstNode>[]

  If the given URI is a directory, remove all documents within this directory. If it is a file, just remove that single document from the documents.

  Parameters

  • uri: URI

  Returns LangiumDocument<AstNode>[]

  the affected LangiumDocuments if existing for convenience

getDocument

• getDocument(uri: URI): undefined | LangiumDocument<AstNode>

  Retrieve the document with the given URI, if present. Otherwise returns undefined.

  Parameters

  • uri: URI

  Returns undefined | LangiumDocument<AstNode>

getOrCreateDocument

• getOrCreateDocument(
      uri: URI,
      cancellationToken?: Cancellation.CancellationToken,
  ): Promise<LangiumDocument<AstNode>>

  Retrieve the document with the given URI. If not present, a new one will be created using the file system access. The new document will be added to the list of documents managed under this service.

  Parameters

  • uri: URI
  • OptionalcancellationToken: Cancellation.CancellationToken

  Returns Promise<LangiumDocument<AstNode>>

hasDocument

• hasDocument(uri: URI): boolean

  Returns true if a document with the given URI is managed under this service.

  Parameters

  • uri: URI

  Returns boolean

invalidateDocument

• invalidateDocument(uri: URI): undefined | LangiumDocument<AstNode>

  Flag the document with the given URI as Changed, if present, meaning that its content is no longer valid. The content (parseResult) stays untouched, while internal data may be dropped to reduce memory footprint.

  Parameters

  • uri: URI

  Returns undefined | LangiumDocument<AstNode>

  the affected LangiumDocument if existing for convenience