Theia API Documentation v1.65.0
    Preparing search index...

    Interface PluginDevServer

    interface PluginDevServer {
        dispose(): void;
        getClient?(): undefined | PluginDevClient;
        getHostedPlugin(): Promise<undefined | PluginMetadata>;
        getHostedPluginInstanceURI(): Promise<string>;
        getHostedPluginURI(): Promise<string>;
        isHostedPluginInstanceRunning(): Promise<boolean>;
        isPluginValid(uri: string): Promise<boolean>;
        isWatchCompilationRunning(uri: string): Promise<boolean>;
        runDebugHostedPluginInstance(
            uri: string,
            debugConfig: PluginDebugConfiguration,
        ): Promise<string>;
        runHostedPluginInstance(uri: string): Promise<string>;
        runWatchCompilation(uri: string): Promise<void>;
        setClient(client: undefined | PluginDevClient): void;
        stopWatchCompilation(uri: string): Promise<void>;
        terminateHostedPluginInstance(): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    dispose getClient? getHostedPlugin getHostedPluginInstanceURI getHostedPluginURI isHostedPluginInstanceRunning isPluginValid isWatchCompilationRunning runDebugHostedPluginInstance runHostedPluginInstance runWatchCompilation setClient stopWatchCompilation terminateHostedPluginInstance

    Methods

    • Dispose this object.

      Returns void

    • Returns undefined | PluginDevClient

    • If this server is a proxy to a remote server then a client is used as a local object to handle RPC messages from the remote server.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods