Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace debug

Namespace for debug functionality.

Index

Variables(3)

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 activeDebugConsole

activeDebugConsole: DebugConsole

The currently active debug console. If no debug session is active, output sent to the debug console is not shown.

Let breakpoints

breakpoints: readonly Breakpoint[]

List of breakpoints.

Functions(13)

Const onDidChangeActiveDebugSession

Const onDidStartDebugSession

Const onDidReceiveDebugSessionCustomEvent

Const onDidTerminateDebugSession

Const onDidChangeBreakpoints

registerDebugConfigurationProvider

  • 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 two trigger kinds are possible: with the value Initial (or if no trigger kind argument is given) the provideDebugConfigurations method is used to provide the initial debug configurations to be copied into a newly created launch.json. With the trigger kind Dynamic the provideDebugConfigurations method is used to dynamically determine debug configurations to be presented to the user (in addition to the static configurations from the launch.json). Please note that the triggerKind argument only applies to the provideDebugConfigurations method: so 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 called multiple times. More than one provider can be registered for the same type.

    Parameters

    Returns Disposable

    A Disposable that unregisters this provider when being disposed.

registerDebugAdapterDescriptorFactory

registerDebugAdapterTrackerFactory

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 Thenable<boolean>

    A thenable that resolves when debugging could be successfully started.

stopDebugging

addBreakpoints

  • addBreakpoints(breakpoints: readonly Breakpoint[]): void

removeBreakpoints

  • removeBreakpoints(breakpoints: readonly Breakpoint[]): void
  • Remove breakpoints.

    Parameters

    • breakpoints: readonly Breakpoint[]

      The breakpoints to remove.

    Returns void

asDebugSourceUri

  • 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.

    Parameters

    • 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

    A uri that can be used to load the contents of the source.

Generated by TypeDoc. Maintained by 洛竹