• Public
  • Public/Protected
  • All

Namespace debug

Namespace for debug functionality.



activeDebugConsole: DebugConsole

The currently active debug console.

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.

breakpoints: readonly Breakpoint[]

List of breakpoints.


  • addBreakpoints(breakpoints: readonly Breakpoint[]): void
  • Converts a "Source" descriptor object received via the Debug Adapter Protocol into a Uri that can be used to load its contents. If the source descriptor is based on a path, a file Uri is returned. If the source descriptor uses a reference number, a specific debug Uri (scheme 'debug') is constructed that requires a corresponding ContentProvider and a running debug session If the "Source" descriptor has insufficient information for creating the Uri, an error is thrown.


    • source: DebugProtocolSource

      An object conforming to the Source type defined in the Debug Adapter Protocol.

    • Optional session: DebugSession

      An optional debug session that will be used when the source descriptor uses a reference number to load the contents from an active debug session.

    Returns Uri

  • Register a debug configuration provider for a specific debug type. The optional triggerKind can be used to specify when the provideDebugConfigurations method of the provider is triggered. Currently there are two situations: (1) providing debug configurations to populate a newly created launch.json (2) providing dynamically generated configurations when the user asks for them through the UI (e.g. via the "Select and Start Debugging" command). Please note that the triggerKind argument only applies to the provideDebugConfigurations method, the resolveDebugConfiguration methods are not affected at all. Registering a single provider with resolve methods for different trigger kinds results in the same resolve methods being called multiple times. More than one provider can be registered for the same type.


    Returns Disposable

    A Disposable that unregisters this provider when being disposed.

  • removeBreakpoints(breakpoints: readonly Breakpoint[]): void
  • 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.


    Returns Thenable<boolean>

    A thenable that resolves when debugging could be successfully started.