Interface HostedInstanceManager

Is responsible for running and handling separate Theia instance with given plugin.

Hierarchy

HostedInstanceManager

Index

Methods

Methods

debug

debug(pluginUri: URI, debugConfig: PluginDebugConfiguration): Promise<URI>

- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:62
Runs specified by the given uri plugin with debug in separate Theia instance.

Parameters
- pluginUri: URI
  
  uri to the plugin source location
- debugConfig: PluginDebugConfiguration
  
  debug configuration
Returns Promise<URI>
uri where new Theia instance is run

getInstanceURI

getInstanceURI(): URI

- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:74
Returns uri where hosted instance is run. Throws error if instance is not running.

Returns URI

getPluginURI

getPluginURI(): URI

- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:80
Returns uri where plugin loaded into hosted instance is located. Throws error if instance is not running.

Returns URI

isPluginValid

isPluginValid(uri: URI): boolean

- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:87
Checks whether given uri points to a valid plugin.

Parameters
- uri: URI
  
  uri to the plugin source location
Returns boolean

isRunning

isRunning(): boolean

- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:45
Checks whether hosted instance is run.

Returns boolean

run

run(pluginUri: URI, port?: number): Promise<URI>

- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:54
Runs specified by the given uri plugin in separate Theia instance.

Parameters
- pluginUri: URI
  
  uri to the plugin source location
- Optional port: number
  
  port on which new instance of Theia should be run. Optional.
Returns Promise<URI>
uri where new Theia instance is run

terminate

terminate(): void

- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:68
Terminates hosted plugin instance. Throws error if instance is not running.

Returns void