Class MonacoWorkspaceContextService

constructor

• new MonacoWorkspaceContextService(): MonacoWorkspaceContextService

  Returns MonacoWorkspaceContextService

Readonly_serviceBrand

ReadonlyonDidChangeWorkbenchState

ReadonlyonDidChangeWorkspaceFolders

ReadonlyonDidChangeWorkspaceName

ReadonlyonWillChangeWorkspaceFolders

getCompleteWorkspace

• getCompleteWorkspace(): Promise<IWorkspace>

  Provides access to the complete workspace object.

  Returns Promise<IWorkspace>

getWorkbenchState

• getWorkbenchState(): WorkbenchState

  Return the state of the workbench.

  WorkbenchState.EMPTY - if the workbench was opened with empty window or file WorkbenchState.FOLDER - if the workbench was opened with a folder WorkbenchState.WORKSPACE - if the workbench was opened with a workspace

  Returns WorkbenchState

getWorkspace

• getWorkspace(): IWorkspace

  Provides access to the workspace object the window is running with. Use getCompleteWorkspace to get complete workspace object.

  Returns IWorkspace

getWorkspaceFolder

• getWorkspaceFolder(resource: URI): null | IWorkspaceFolder

  Returns the folder for the given resource from the workspace. Can be null if there is no workspace or the resource is not inside the workspace.

  Parameters

  • resource: URI

  Returns null | IWorkspaceFolder

isCurrentWorkspace

• isCurrentWorkspace(
      workspaceIdOrFolder:
          | URI
          | IWorkspaceIdentifier
          | ISingleFolderWorkspaceIdentifier,
  ): boolean

  Return true if the current workspace has the given identifier or root URI otherwise false.

  Parameters

  • workspaceIdOrFolder: URI | IWorkspaceIdentifier | ISingleFolderWorkspaceIdentifier

  Returns boolean

isInsideWorkspace

• isInsideWorkspace(resource: URI): boolean

  Returns if the provided resource is inside the workspace or not.

  Parameters

  • resource: URI

  Returns boolean