VS Code API
    Preparing search index...

    Interface DebugConfigurationProvider

    A debug configuration provider allows to add debug configurations to the debug service and to resolve launch configurations before they are used to start a debug session. A debug configuration provider is registered via debug.registerDebugConfigurationProvider.

    interface DebugConfigurationProvider {
        provideDebugConfigurations?(
            folder: WorkspaceFolder | undefined,
            token?: CancellationToken,
        ): ProviderResult<DebugConfiguration[]>;
        resolveDebugConfiguration?(
            folder: WorkspaceFolder | undefined,
            debugConfiguration: DebugConfiguration,
            token?: CancellationToken,
        ): ProviderResult<DebugConfiguration>;
        resolveDebugConfigurationWithSubstitutedVariables?(
            folder: WorkspaceFolder | undefined,
            debugConfiguration: DebugConfiguration,
            token?: CancellationToken,
        ): ProviderResult<DebugConfiguration>;
    }
    Index

    Methods

    • Resolves a debug configuration by filling in missing values or by adding/changing/removing attributes. If more than one debug configuration provider is registered for the same type, the resolveDebugConfiguration calls are chained in arbitrary order and the initial debug configuration is piped through the chain. Returning the value 'undefined' prevents the debug session from starting. Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.

      Parameters

      Returns ProviderResult<DebugConfiguration>

      The resolved debug configuration or undefined or null.

    • This hook is directly called after 'resolveDebugConfiguration' but with all variables substituted. It can be used to resolve or verify a debug configuration by filling in missing values or by adding/changing/removing attributes. If more than one debug configuration provider is registered for the same type, the 'resolveDebugConfigurationWithSubstitutedVariables' calls are chained in arbitrary order and the initial debug configuration is piped through the chain. Returning the value 'undefined' prevents the debug session from starting. Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.

      Parameters

      Returns ProviderResult<DebugConfiguration>

      The resolved debug configuration or undefined or null.