Class DefaultWorkspaceServer

Contribution for hooking into the backend lifecycle:

initialize()
configure(expressApp)
onStart(httpServer)
onStop()

Implements

Constructors

constructor

new DefaultWorkspaceServer(): DefaultWorkspaceServer
Returns DefaultWorkspaceServer

Properties

`Protected` `Readonly`cliParams

cliParams: WorkspaceCliContribution

`Protected` `Readonly`envServer

envServer: EnvVariablesServer

`Protected`root

root: Deferred<undefined | string> = ...

`Protected` `Readonly`untitledWorkspaceService

untitledWorkspaceService: UntitledWorkspaceService

`Protected`untitledWorkspaceStaleThreshold

untitledWorkspaceStaleThreshold: number = 10

Untitled workspaces that are not among the most recent N workspaces will be deleted on start. Increase this number to keep older files, lower it to delete stale untitled workspaces more aggressively.

`Protected` `Readonly`workspaceHandlers

workspaceHandlers: ContributionProvider<WorkspaceHandlerContribution>

Methods

`Protected`doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/node/default-workspace-server.ts:117

getMostRecentlyUsedWorkspace

getMostRecentlyUsedWorkspace(): Promise<undefined | string>
Returns with a promise that resolves to the most recently used workspace folder URI as a string. Resolves to undefined if the workspace folder is not yet set.

Returns Promise<undefined | string>
Implementation of WorkspaceServer.getMostRecentlyUsedWorkspace
- Defined in packages/workspace/src/node/default-workspace-server.ts:137

getRecentWorkspaces

getRecentWorkspaces(): Promise<string[]>
Returns list of recently opened workspaces as an array.

Returns Promise<string[]>
Implementation of WorkspaceServer.getRecentWorkspaces
- Defined in packages/workspace/src/node/default-workspace-server.ts:161

`Protected`getRoot

getRoot(): Promise<undefined | string>
Returns Promise<undefined | string>
- Defined in packages/workspace/src/node/default-workspace-server.ts:126

`Protected`getUserStoragePath

getUserStoragePath(): Promise<string>
Returns Promise<string>
- Defined in packages/workspace/src/node/default-workspace-server.ts:220

`Protected`getWorkspaceURIFromCli

getWorkspaceURIFromCli(): Promise<undefined | string>
Returns Promise<undefined | string>
- Defined in packages/workspace/src/node/default-workspace-server.ts:182

`Protected`init

init(): void
Returns void
- Defined in packages/workspace/src/node/default-workspace-server.ts:113

onStart

onStart(): Promise<void>
Called right after the server for the Express app is started. Use this to additionally configure the server or as ready-signal for your service.

The implementation may be async, however it will still block the startup step until it's resolved.

Returns Promise<void>
either undefined or a Promise resolving to undefined.
Implementation of BackendApplicationContribution.onStart
- Defined in packages/workspace/src/node/default-workspace-server.ts:122

`Protected`readJsonFromFile

readJsonFromFile(fsPath: string): Promise<undefined | object>
Parameters
- fsPath: string
Returns Promise<undefined | object>
- Defined in packages/workspace/src/node/default-workspace-server.ts:212

`Protected`readRecentWorkspacePathsFromUserHome

readRecentWorkspacePathsFromUserHome(): Promise<
undefined
| RecentWorkspacePathsData,
>
Reads the most recently used workspace root from the user's home directory.

Returns Promise<undefined | RecentWorkspacePathsData>
- Defined in packages/workspace/src/node/default-workspace-server.ts:206

`Protected`removeOldUntitledWorkspaces

removeOldUntitledWorkspaces(): Promise<void>
Removes untitled workspaces that are not among the most recently used workspaces. Use the untitledWorkspaceStaleThreshold to configure when to delete workspaces.

Returns Promise<void>
- Defined in packages/workspace/src/node/default-workspace-server.ts:229

removeRecentWorkspace

removeRecentWorkspace(rawUri: string): Promise<void>
Removes a workspace from the list of recently opened workspaces.
Parameters
- rawUri: string
  the workspace uri.
Returns Promise<void>
Implementation of WorkspaceServer.removeRecentWorkspace
- Defined in packages/workspace/src/node/default-workspace-server.ts:149

setMostRecentlyUsedWorkspace

setMostRecentlyUsedWorkspace(rawUri: string): Promise<void>
Sets the desired string representation of the URI as the most recently used workspace folder.
Parameters
- rawUri: string
Returns Promise<void>
Implementation of WorkspaceServer.setMostRecentlyUsedWorkspace
- Defined in packages/workspace/src/node/default-workspace-server.ts:141

`Protected`workspaceStillExist

workspaceStillExist(workspaceRootUri: string): Promise<boolean>
Parameters
- workspaceRootUri: string
Returns Promise<boolean>
- Defined in packages/workspace/src/node/default-workspace-server.ts:171

`Protected`writeToFile

writeToFile(fsPath: string, data: object): Promise<void>
Parameters
- fsPath: string
- data: object
Returns Promise<void>
- Defined in packages/workspace/src/node/default-workspace-server.ts:196

`Protected`writeToUserHome

writeToUserHome(data: RecentWorkspacePathsData): Promise<void>
Writes the given uri as the most recently used workspace root to the user's home directory.
Parameters
- data: RecentWorkspacePathsData
Returns Promise<void>
- Defined in packages/workspace/src/node/default-workspace-server.ts:191

Class DefaultWorkspaceServer

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DefaultWorkspaceServer

Properties

Protected ReadonlycliParams

Protected ReadonlyenvServer

Protectedroot

Protected ReadonlyuntitledWorkspaceService

ProtecteduntitledWorkspaceStaleThreshold

Protected ReadonlyworkspaceHandlers

Methods

ProtecteddoInit

Returns Promise<void>

getMostRecentlyUsedWorkspace

Returns Promise<undefined | string>

getRecentWorkspaces

Returns Promise<string[]>

ProtectedgetRoot

Returns Promise<undefined | string>

ProtectedgetUserStoragePath

Returns Promise<string>

ProtectedgetWorkspaceURIFromCli

Returns Promise<undefined | string>

Protectedinit

Returns void

onStart

Returns Promise<void>

ProtectedreadJsonFromFile

Parameters

Returns Promise<undefined | object>

ProtectedreadRecentWorkspacePathsFromUserHome

Returns Promise<undefined | RecentWorkspacePathsData>

ProtectedremoveOldUntitledWorkspaces

Returns Promise<void>

removeRecentWorkspace

Parameters

Returns Promise<void>

setMostRecentlyUsedWorkspace

Parameters

Returns Promise<void>

ProtectedworkspaceStillExist

Parameters

Returns Promise<boolean>

ProtectedwriteToFile

Parameters

Returns Promise<void>

ProtectedwriteToUserHome

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`cliParams

`Protected` `Readonly`envServer

`Protected`root

`Protected` `Readonly`untitledWorkspaceService

`Protected`untitledWorkspaceStaleThreshold

`Protected` `Readonly`workspaceHandlers

`Protected`doInit

`Protected`getRoot

`Protected`getUserStoragePath

`Protected`getWorkspaceURIFromCli

`Protected`init

`Protected`readJsonFromFile

`Protected`readRecentWorkspacePathsFromUserHome

`Protected`removeOldUntitledWorkspaces

`Protected`workspaceStillExist

`Protected`writeToFile

`Protected`writeToUserHome