VS Code API
    Preparing search index...

    Interface DebugSession

    A debug session.

    interface DebugSession {
        configuration: DebugConfiguration;
        id: string;
        name: string;
        parentSession?: DebugSession;
        type: string;
        workspaceFolder: WorkspaceFolder | undefined;
        customRequest(command: string, args?: any): Thenable<any>;
        getDebugProtocolBreakpoint(
            breakpoint: Breakpoint,
        ): Thenable<DebugProtocolBreakpoint | undefined>;
    }
    Index

    Properties

    configuration id name parentSession? type workspaceFolder

    Methods

    customRequest getDebugProtocolBreakpoint

    Properties

    configuration: DebugConfiguration

    The "resolved" debug configuration of this session. "Resolved" means that

    • all variables have been substituted and
    • platform specific attribute sections have been "flattened" for the matching platform and removed for non-matching platforms.
    id: string

    The unique ID of this debug session.

    name: string

    The debug session's name is initially taken from the debug configuration. Any changes will be properly reflected in the UI.

    parentSession?: DebugSession

    The parent session of this debug session, if it was created as a child.

    DebugSessionOptions.parentSession

    type: string

    The debug session's type from the debug configuration.

    workspaceFolder: WorkspaceFolder | undefined

    The workspace folder of this session or undefined for a folderless setup.

    Methods

    • Send a custom request to the debug adapter.

      Parameters

      • command: string
      • Optionalargs: any

      Returns Thenable<any>

    • Maps a breakpoint in the editor to the corresponding Debug Adapter Protocol (DAP) breakpoint that is managed by the debug adapter of the debug session. If no DAP breakpoint exists (either because the editor breakpoint was not yet registered or because the debug adapter is not interested in the breakpoint), the value undefined is returned.

      Parameters

      Returns Thenable<DebugProtocolBreakpoint | undefined>

      A promise that resolves to the Debug Adapter Protocol breakpoint or undefined.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods