Class DocumentsExtImpl

constructor

• new DocumentsExtImpl(
      rpc: RPCProtocol,
      editorsAndDocuments: EditorsAndDocumentsExtImpl,
  ): DocumentsExtImpl

  Parameters

  • rpc: RPCProtocol
  • editorsAndDocuments: EditorsAndDocumentsExtImpl

  Returns DocumentsExtImpl

ReadonlyonDidAddDocument

ReadonlyonDidChangeDocument

ReadonlyonDidRemoveDocument

ReadonlyonDidSaveTextDocument

ReadonlyonWillSaveTextDocument

$acceptDirtyStateChanged

• $acceptDirtyStateChanged(strUrl: UriComponents, isDirty: boolean): void

  eslint-enable @typescript-eslint/no-explicit-any

  Parameters

  • strUrl: UriComponents
  • isDirty: boolean

  Returns void

$acceptEncodingChanged

• $acceptEncodingChanged(strUrl: UriComponents, encoding: string): void

  Parameters

  • strUrl: UriComponents
  • encoding: string

  Returns void

$acceptModelChanged

• $acceptModelChanged(
      strUrl: UriComponents,
      e: ModelChangedEvent,
      isDirty: boolean,
  ): void

  Parameters

  • strUrl: UriComponents
  • e: ModelChangedEvent
  • isDirty: boolean

  Returns void

$acceptModelModeChanged

• $acceptModelModeChanged(
      startUrl: UriComponents,
      oldModeId: string,
      newModeId: string,
  ): void

  Parameters

  • startUrl: UriComponents
  • oldModeId: string
  • newModeId: string

  Returns void

$acceptModelSaved

• $acceptModelSaved(strUrl: UriComponents): void

  Parameters

  • strUrl: UriComponents

  Returns void

$acceptModelWillSave

• $acceptModelWillSave(
      strUrl: UriComponents,
      reason: TextDocumentSaveReason,
      saveTimeout: number,
  ): Promise<SingleEditOperation[]>

  Parameters

  • strUrl: UriComponents
  • reason: TextDocumentSaveReason
  • saveTimeout: number

  Returns Promise<SingleEditOperation[]>

createDocumentData

• createDocumentData(
      options?: { content?: string; encoding?: string; language?: string },
  ): Promise<URI>

  Parameters

  • Optionaloptions: { content?: string; encoding?: string; language?: string }

  Returns Promise<URI>

getAllDocumentData

• getAllDocumentData(): DocumentDataExt[]

  Returns DocumentDataExt[]

getDocument

• getDocument(resource: Uri): TextDocument

  Parameters

  • resource: Uri

  Returns TextDocument

getDocumentData

• getDocumentData(resource: Uri): undefined | DocumentDataExt

  Parameters

  • resource: Uri

  Returns undefined | DocumentDataExt

openDocument

• openDocument(
      uri: URI,
      options?: { content?: string; encoding?: string; language?: string },
  ): Promise<undefined | DocumentDataExt>

  Parameters

  • uri: URI
  • Optionaloptions: { content?: string; encoding?: string; language?: string }

  Returns Promise<undefined | DocumentDataExt>

setWordDefinitionFor

• setWordDefinitionFor(modeId: string, wordDefinition: null | RegExp): void

  Parameters

  • modeId: string
  • wordDefinition: null | RegExp

  Returns void

showDocument

• showDocument(
      uri: URI,
      options?: TextDocumentShowOptions,
  ): Promise<undefined | DocumentDataExt>

  Retrieve document and open it in the editor if need.

  Parameters

  • uri: URI

    path to the resource

  • Optionaloptions: TextDocumentShowOptions

    if options exists, resource will be opened in editor, otherwise only document object is returned

  Returns Promise<undefined | DocumentDataExt>