$ModuleDebug$Typings extension

on

Properties

activeDebugConsole → DebugConsole
The currently active {@link DebugConsoledebug console}. If no debug session is active, output sent to the debug console is not shown.
no setter
activeDebugSession → DebugSession?
The currently active {@link DebugSessiondebug 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.
no setter
breakpoints → List<Breakpoint>
List of breakpoints.
no setter
onDidChangeActiveDebugSession → Event<DebugSession?>
An {@link Event} which fires when the {@link debug.activeDebugSessionactive debug session} has changed. Note that the event also fires when the active debug session changes to undefined.
no setter
onDidChangeBreakpoints → Event<BreakpointsChangeEvent>
An {@link Event} that is emitted when the set of breakpoints is added, removed, or changed.
no setter
onDidReceiveDebugSessionCustomEvent → Event<DebugSessionCustomEvent>
An {@link Event} which fires when a custom DAP event is received from the {@link DebugSessiondebug session}.
no setter
onDidStartDebugSession → Event<DebugSession>
An {@link Event} which fires when a new {@link DebugSessiondebug session} has been started.
no setter
onDidTerminateDebugSession → Event<DebugSession>
An {@link Event} which fires when a {@link DebugSessiondebug session} has terminated.
no setter

Methods

addBreakpoints(List<Breakpoint> breakpoints) → void
Add breakpoints.
asDebugSourceUri(DebugProtocolSource source, [DebugSession? session]) → Uri
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
registerDebugAdapterDescriptorFactory(String debugType, DebugAdapterDescriptorFactory factory) → Disposable
Register a {@link DebugAdapterDescriptorFactorydebug adapter descriptor factory} for a specific debug type. An extension is only allowed to register a DebugAdapterDescriptorFactory for the debug type(s) defined by the extension. Otherwise an error is thrown. Registering more than one DebugAdapterDescriptorFactory for a debug type results in an error.
registerDebugAdapterTrackerFactory(String debugType, DebugAdapterTrackerFactory factory) → Disposable
Register a debug adapter tracker factory for the given debug type.
registerDebugConfigurationProvider(String debugType, DebugConfigurationProvider provider, [DebugConfigurationProviderTriggerKind? triggerKind]) → Disposable
Register a {@link DebugConfigurationProviderdebug configuration provider} for a specific debug type. The optional {@link DebugConfigurationProviderTriggerKindtriggerKind} 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.
removeBreakpoints(List<Breakpoint> breakpoints) → void
Remove breakpoints.
startDebugging(WorkspaceFolder? folder, Object nameOrConfiguration, [Object? parentSessionOrOptions]) → Future
Start debugging by using either a named launch or named compound configuration, or by directly passing a {@link 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.
stopDebugging([DebugSession? session]) → Future
Stop the given debug session or stop all debug sessions if session is omitted.