You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
303 lines
19 KiB
303 lines
19 KiB
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>DebugConfigurationProvider | VS Code API 中文文档</title>
|
|
<meta name="description" content="Documentation for VS Code API 中文文档">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">VS Code API 中文文档</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../index.html">VS Code API 中文文档</a>
|
|
</li>
|
|
<li>
|
|
<a href="DebugConfigurationProvider.html">DebugConfigurationProvider</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface DebugConfigurationProvider</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>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 <a href="../modules/debug.html#registerDebugConfigurationProvider">debug.registerDebugConfigurationProvider</a>.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">DebugConfigurationProvider</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>索引</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="DebugConfigurationProvider.html#provideDebugConfigurations" class="tsd-kind-icon">provide<wbr>Debug<wbr>Configurations</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="DebugConfigurationProvider.html#resolveDebugConfiguration" class="tsd-kind-icon">resolve<wbr>Debug<wbr>Configuration</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="DebugConfigurationProvider.html#resolveDebugConfigurationWithSubstitutedVariables" class="tsd-kind-icon">resolve<wbr>Debug<wbr>Configuration<wbr>With<wbr>Substituted<wbr>Variables</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="provideDebugConfigurations" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> provide<wbr>Debug<wbr>Configurations</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">provide<wbr>Debug<wbr>Configurations<span class="tsd-signature-symbol">(</span>folder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a>, token<span class="tsd-signature-symbol">?: </span><a href="CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/b8218fd/vscode.d.ts#L12735">vscode.d.ts:12735</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Provides <a href="DebugConfiguration.html">debug configuration</a> to the debug service. If more than one debug configuration provider is
|
|
registered for the same type, debug configurations are concatenated in arbitrary order.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>folder: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The workspace folder for which the configurations are used or <code>undefined</code> for a folderless setup.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <a href="CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A cancellation token.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>An array of <a href="DebugConfiguration.html">debug configurations</a>.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="resolveDebugConfiguration" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> resolve<wbr>Debug<wbr>Configuration</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">resolve<wbr>Debug<wbr>Configuration<span class="tsd-signature-symbol">(</span>folder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a>, debugConfiguration<span class="tsd-signature-symbol">: </span><a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a>, token<span class="tsd-signature-symbol">?: </span><a href="CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/b8218fd/vscode.d.ts#L12749">vscode.d.ts:12749</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Resolves a <a href="DebugConfiguration.html">debug configuration</a> 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.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>folder: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The workspace folder from which the configuration originates from or <code>undefined</code> for a folderless setup.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>debugConfiguration: <a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <a href="DebugConfiguration.html">debug configuration</a> to resolve.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <a href="CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A cancellation token.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>The resolved debug configuration or undefined or null.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="resolveDebugConfigurationWithSubstitutedVariables" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> resolve<wbr>Debug<wbr>Configuration<wbr>With<wbr>Substituted<wbr>Variables</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">resolve<wbr>Debug<wbr>Configuration<wbr>With<wbr>Substituted<wbr>Variables<span class="tsd-signature-symbol">(</span>folder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a>, debugConfiguration<span class="tsd-signature-symbol">: </span><a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a>, token<span class="tsd-signature-symbol">?: </span><a href="CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/b8218fd/vscode.d.ts#L12764">vscode.d.ts:12764</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>This hook is directly called after 'resolveDebugConfiguration' but with all variables substituted.
|
|
It can be used to resolve or verify a <a href="DebugConfiguration.html">debug configuration</a> 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.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>folder: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The workspace folder from which the configuration originates from or <code>undefined</code> for a folderless setup.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>debugConfiguration: <a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <a href="DebugConfiguration.html">debug configuration</a> to resolve.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <a href="CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A cancellation token.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><a href="DebugConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">DebugConfiguration</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>The resolved debug configuration or undefined or null.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../index.html">Exports</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface">
|
|
<a href="DebugConfigurationProvider.html" class="tsd-kind-icon">Debug<wbr>Configuration<wbr>Provider</a>
|
|
<ul>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="DebugConfigurationProvider.html#provideDebugConfigurations" class="tsd-kind-icon">provide<wbr>Debug<wbr>Configurations</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="DebugConfigurationProvider.html#resolveDebugConfiguration" class="tsd-kind-icon">resolve<wbr>Debug<wbr>Configuration</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="DebugConfigurationProvider.html#resolveDebugConfigurationWithSubstitutedVariables" class="tsd-kind-icon">resolve<wbr>Debug<wbr>Configuration<wbr>With<wbr>Substituted<wbr>Variables</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>图例</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated by <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |