Class DebugServiceImpl

DebugService implementation.

Implements

DebugService

Constructors

constructor

new DebugServiceImpl(): DebugServiceImpl
Returns DebugServiceImpl

Properties

`Protected` `Readonly`registry

registry: DebugAdapterContributionRegistry

`Protected` `Readonly`sessionManager

sessionManager: DebugAdapterSessionManager

`Protected` `Readonly`sessions

sessions: Set<string> = ...

Accessors

onDidChangeDebugConfigurationProviders

get onDidChangeDebugConfigurationProviders(): Event<void>
Event handle to indicate when one or more dynamic debug configuration providers have been registered or unregistered.

Returns Event<void>
Implementation of DebugService.onDidChangeDebugConfigurationProviders
- Defined in packages/debug/src/node/debug-service-impl.ts:38

Methods

createDebugSession

createDebugSession(
config: DebugConfiguration,
_workspaceFolderUri?: string,
): Promise<string>
Creates a new debug adapter session.
Parameters
- config: DebugConfiguration
  The resolved debug configuration.
- Optional_workspaceFolderUri: string
  The workspace folder for this sessions or undefined when folderless
Returns Promise<string>
The identifier of the created debug adapter session.
Implementation of DebugService.createDebugSession
- Defined in packages/debug/src/node/debug-service-impl.ts:98

debugTypes

debugTypes(): Promise<string[]>
Finds and returns an array of registered debug types.

Returns Promise<string[]>
An array of registered debug types
Implementation of DebugService.debugTypes
- Defined in packages/debug/src/node/debug-service-impl.ts:46

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of DebugService.dispose
- Defined in packages/debug/src/node/debug-service-impl.ts:42

`Protected`doStop

doStop(sessionId: string): Promise<void>
Parameters
- sessionId: string
Returns Promise<void>
- Defined in packages/debug/src/node/debug-service-impl.ts:123

fetchDynamicDebugConfiguration

fetchDynamicDebugConfiguration(
    name: string,
    type: string,
    folder?: string,
): Promise<undefined | DebugConfiguration>
Provides a dynamic debug configuration matching the name and the provider debug type
Parameters
- name: string
- type: string
- Optionalfolder: string
Returns Promise<undefined | DebugConfiguration>
Implementation of DebugService.fetchDynamicDebugConfiguration
- Defined in packages/debug/src/node/debug-service-impl.ts:86

getConfigurationSnippets

getConfigurationSnippets(): Promise<IJSONSchemaSnippet[]>
Returns Promise<IJSONSchemaSnippet[]>
Implementation of DebugService.getConfigurationSnippets
- Defined in packages/debug/src/node/debug-service-impl.ts:58

getDebuggersForLanguage

getDebuggersForLanguage(language: string): Promise<DebuggerDescription[]>
Parameters
- language: string
Returns Promise<DebuggerDescription[]>
Implementation of DebugService.getDebuggersForLanguage
- Defined in packages/debug/src/node/debug-service-impl.ts:50

getDynamicDebugConfigurationProviders

getDynamicDebugConfigurationProviders(): DynamicDebugConfigurationProvider[]
Returns dynamic debug configuration providers grouped by label. Each entry contains a label and all the types that share that label. This allows the UI to show human-readable labels and group related types.

Returns DynamicDebugConfigurationProvider[]
Implementation of DebugService.getDynamicDebugConfigurationProviders
- Defined in packages/debug/src/node/debug-service-impl.ts:78

getDynamicDebugConfigurationProviderTypes

getDynamicDebugConfigurationProviderTypes(): string[]
Returns the types of registered dynamic debug configuration providers without invoking them. This is a lightweight alternative to provideDynamicDebugConfigurations when you only need to know what provider types are available.

Returns string[]
Deprecated
Use getDynamicDebugConfigurationProviders() instead for proper label support.
Implementation of DebugService.getDynamicDebugConfigurationProviderTypes
- Defined in packages/debug/src/node/debug-service-impl.ts:82

getSchemaAttributes

getSchemaAttributes(debugType: string): Promise<IJSONSchema[]>
Provides the schema attributes.
Parameters
- debugType: string
  The registered debug type
Returns Promise<IJSONSchema[]>
An JSON Schema describing the configuration attributes for the given debug type
Implementation of DebugService.getSchemaAttributes
- Defined in packages/debug/src/node/debug-service-impl.ts:54

provideDebugConfigurations

provideDebugConfigurations(
debugType: string,
workspaceFolderUri?: string,
): Promise<DebugConfiguration[]>
Provides initial debug configuration.
Parameters
- debugType: string
  The registered debug type
- OptionalworkspaceFolderUri: string
Returns Promise<DebugConfiguration[]>
An array of debug configurations
Implementation of DebugService.provideDebugConfigurations
- Defined in packages/debug/src/node/debug-service-impl.ts:67

provideDebuggerVariables

provideDebuggerVariables(debugType: string): Promise<CommandIdVariables>
Provide debugger contributed variables see "variables" at https://code.visualstudio.com/api/references/contribution-points#contributes.debuggers
Parameters
- debugType: string
Returns Promise<CommandIdVariables>
Implementation of DebugService.provideDebuggerVariables
- Defined in packages/debug/src/node/debug-service-impl.ts:62

provideDynamicDebugConfigurations

provideDynamicDebugConfigurations(): Promise<
Record<string, DebugConfiguration[]>,
>
Returns Promise<Record<string, DebugConfiguration[]>>
A Record of debug configuration provider types and a corresponding dynamic debug configurations array
Implementation of DebugService.provideDynamicDebugConfigurations
- Defined in packages/debug/src/node/debug-service-impl.ts:70

provideDynamicDebugConfigurationsByType

provideDynamicDebugConfigurationsByType(
type: string,
folder?: string,
): Promise<DebugConfiguration[]>
Provides dynamic debug configurations for a specific provider type only.
Parameters
- type: string
  The debug configuration provider type
- Optionalfolder: string
  The workspace folder URI
Returns Promise<DebugConfiguration[]>
An array of debug configurations for the specified type
Implementation of DebugService.provideDynamicDebugConfigurationsByType
- Defined in packages/debug/src/node/debug-service-impl.ts:74

resolveDebugConfiguration

resolveDebugConfiguration(
config: DebugConfiguration,
workspaceFolderUri?: string,
): Promise<DebugConfiguration>
Resolves a debug configuration by filling in missing values or by adding/changing/removing attributes before variable substitution.
Parameters
- config: DebugConfiguration
- OptionalworkspaceFolderUri: string
Returns Promise<DebugConfiguration>
The resolved debug configuration, undefined or null.
Implementation of DebugService.resolveDebugConfiguration
- Defined in packages/debug/src/node/debug-service-impl.ts:90

resolveDebugConfigurationWithSubstitutedVariables

resolveDebugConfigurationWithSubstitutedVariables(
config: DebugConfiguration,
workspaceFolderUri?: string,
): Promise<DebugConfiguration>
Resolves a debug configuration by filling in missing values or by adding/changing/removing attributes with substituted variables.
Parameters
- config: DebugConfiguration
- OptionalworkspaceFolderUri: string
Returns Promise<DebugConfiguration>
The resolved debug configuration, undefined or null.
Implementation of DebugService.resolveDebugConfigurationWithSubstitutedVariables
- Defined in packages/debug/src/node/debug-service-impl.ts:93

terminateDebugSession

terminateDebugSession(sessionId?: string): Promise<void>
Stop a running session for the given session id.
Parameters
- OptionalsessionId: string
Returns Promise<void>
Implementation of DebugService.terminateDebugSession
- Defined in packages/debug/src/node/debug-service-impl.ts:104

Class DebugServiceImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DebugServiceImpl

Properties

Protected Readonlyregistry

Protected ReadonlysessionManager

Protected Readonlysessions

Accessors

onDidChangeDebugConfigurationProviders

Returns Event<void>

Methods

createDebugSession

Parameters

Returns Promise<string>

debugTypes

Returns Promise<string[]>

dispose

Returns void

ProtecteddoStop

Parameters

Returns Promise<void>

fetchDynamicDebugConfiguration

Parameters

Returns Promise<undefined | DebugConfiguration>

getConfigurationSnippets

Returns Promise<IJSONSchemaSnippet[]>

getDebuggersForLanguage

Parameters

Returns Promise<DebuggerDescription[]>

getDynamicDebugConfigurationProviders

Returns DynamicDebugConfigurationProvider[]

getDynamicDebugConfigurationProviderTypes

Returns string[]

Deprecated

getSchemaAttributes

Parameters

Returns Promise<IJSONSchema[]>

provideDebugConfigurations

Parameters

Returns Promise<DebugConfiguration[]>

provideDebuggerVariables

Parameters

Returns Promise<CommandIdVariables>

provideDynamicDebugConfigurations

Returns Promise<Record<string, DebugConfiguration[]>>

provideDynamicDebugConfigurationsByType

Parameters

Returns Promise<DebugConfiguration[]>

resolveDebugConfiguration

Parameters

Returns Promise<DebugConfiguration>

resolveDebugConfigurationWithSubstitutedVariables

Parameters

Returns Promise<DebugConfiguration>

terminateDebugSession

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`registry

`Protected` `Readonly`sessionManager

`Protected` `Readonly`sessions

`Protected`doStop