Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace for debug functionality.

Index

Variables

Let activeDebugConsole

activeDebugConsole: DebugConsole

The currently active debug console.

Let activeDebugSession

activeDebugSession: DebugSession | undefined

The currently active debug session or undefined. The active debug session is the one represented by the debug action floating window or the one currently shown in the drop down menu of the debug action floating window. If no debug session is active, the value is undefined.

Let breakpoints

breakpoints: Breakpoint[]

List of breakpoints.

Const onDidChangeActiveDebugSession

onDidChangeActiveDebugSession: Event<DebugSession | undefined>

An event which fires when the active debug session has changed. Note that the event also fires when the active debug session changes to undefined.

Const onDidChangeBreakpoints

onDidChangeBreakpoints: Event<BreakpointsChangeEvent>

An event that is emitted when the set of breakpoints is added, removed, or changed.

Const onDidReceiveDebugSessionCustomEvent

onDidReceiveDebugSessionCustomEvent: Event<DebugSessionCustomEvent>

An event which fires when a custom DAP event is received from the debug session.

Const onDidStartDebugSession

onDidStartDebugSession: Event<DebugSession>

An event which fires when a new debug session has been started.

Const onDidTerminateDebugSession

onDidTerminateDebugSession: Event<DebugSession>

An event which fires when a debug session has terminated.

Functions

addBreakpoints

registerDebugAdapterDescriptorFactory

registerDebugAdapterTrackerFactory

registerDebugConfigurationProvider

removeBreakpoints

  • removeBreakpoints(breakpoints: Breakpoint[]): void

startDebugging

  • Start debugging by using either a named launch or named compound configuration, or by directly passing a DebugConfiguration. The named configurations are looked up in '.vscode/launch.json' found in the given folder. Before debugging starts, all unsaved files are saved and the launch configurations are brought up-to-date. Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder.

    Parameters

    Returns PromiseLike<boolean>

    A thenable that resolves when debugging could be successfully started.