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

    Interface DebugService

    This service provides functionality to configure and to start a new debug adapter session. The workflow is the following. If user wants to debug an application and there is no debug configuration associated with the application then the list of available providers is requested to create suitable debug configuration. When configuration is chosen it is possible to alter the configuration by filling in missing values or by adding/changing/removing attributes. For this purpose the #resolveDebugConfiguration method is invoked. After that the debug adapter session will be started.

    interface DebugService {
        onDidChangeDebugConfigurationProviders: Event<void>;
        onDidChangeDebuggers?: Event<void>;
        createDebugSession(
            config: DebugConfiguration,
            workspaceFolderUri: undefined | string,
        ): Promise<string>;
        debugTypes(): Promise<string[]>;
        dispose(): void;
        fetchDynamicDebugConfiguration(
            name: string,
            type: string,
            folder?: string,
        ): Promise<undefined | DebugConfiguration>;
        getConfigurationSnippets(): Promise<IJSONSchemaSnippet[]>;
        getDebuggersForLanguage(language: string): Promise<DebuggerDescription[]>;
        getSchemaAttributes(debugType: string): Promise<IJSONSchema[]>;
        provideDebugConfigurations(
            debugType: string,
            workspaceFolderUri: undefined | string,
        ): Promise<DebugConfiguration[]>;
        provideDebuggerVariables(debugType: string): Promise<CommandIdVariables>;
        provideDynamicDebugConfigurations?(
            folder?: string,
        ): Promise<Record<string, DebugConfiguration[]>>;
        resolveDebugConfiguration(
            config: DebugConfiguration,
            workspaceFolderUri: undefined | string,
        ): Promise<undefined | null | DebugConfiguration>;
        resolveDebugConfigurationWithSubstitutedVariables(
            config: DebugConfiguration,
            workspaceFolderUri: undefined | string,
        ): Promise<undefined | null | DebugConfiguration>;
        terminateDebugSession(sessionId: string): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    onDidChangeDebugConfigurationProviders onDidChangeDebuggers?

    Methods

    createDebugSession debugTypes dispose fetchDynamicDebugConfiguration getConfigurationSnippets getDebuggersForLanguage getSchemaAttributes provideDebugConfigurations provideDebuggerVariables provideDynamicDebugConfigurations? resolveDebugConfiguration resolveDebugConfigurationWithSubstitutedVariables terminateDebugSession

    Properties

    onDidChangeDebugConfigurationProviders: Event<void>

    Event handle to indicate when one or more dynamic debug configuration providers have been registered or unregistered.

    onDidChangeDebuggers?: Event<void>

    Methods

    • Dispose this object.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods