<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > debug | VS Code API 中文文档< / title >
< meta name = "description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API。这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档。" >
< meta property = "og:site_name" content = "Vscode Api 中文文档" >
< meta property = "og:type" content = "docs" >
< meta property = "og:url" content = "https://vscode-api-cn.js.org/index.html" >
< meta property = "article:tag" content = "vscode" >
< meta property = "article:tag" content = "vscode api" >
< meta property = "article:tag" content = "vscode api 中文文档" >
< meta property = "article:tag" content = "vscode api 文档" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "shortcut icon" href = "https://code.visualstudio.com/favicon.ico" sizes = "128x128" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< script async src = "https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-4070818774984451" crossorigin = "anonymous" > < / script >
< meta name = "monetag" content = "eb1e3d5247d1754d0fd449f7b99b110d" >
< meta name = "a.validate.02" content = "FfmmKD6EanKVetA49MTlFFi-untsfhnAgRiw" / >
< script type = "text/javascript" >
(function (c, l, a, r, i, t, y) {
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
})(window, document, "clarity", "script", "g1cbw4nxoq");
< / script >
<!-- Google tag (gtag.js) -->
< script async src = "https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-T4TRRS1LB1');
< / script >
< style >
.container-main {
padding-bottom: 50px;
}
< / style >
< / 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 = "../modules.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "vscode.html" > vscode< / a >
< / li >
< li >
< a href = "vscode.debug.html" > debug< / a >
< / li >
< / ul >
< h1 > Namespace debug< / 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 > Namespace for debug functionality.< / p >
< / div >
< / div >
< / 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 > Variables（ ） < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-variable tsd-parent-kind-namespace" > < a href = "vscode.debug.html#activeDebugSession" class = "tsd-kind-icon" > active< wbr > Debug< wbr > Session< / a > < / li >
< li class = "tsd-kind-variable tsd-parent-kind-namespace" > < a href = "vscode.debug.html#activeDebugConsole" class = "tsd-kind-icon" > active< wbr > Debug< wbr > Console< / a > < / li >
< li class = "tsd-kind-variable tsd-parent-kind-namespace" > < a href = "vscode.debug.html#breakpoints" class = "tsd-kind-icon" > breakpoints< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Functions（ ） < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#onDidChangeActiveDebugSession" class = "tsd-kind-icon" > on< wbr > Did< wbr > Change< wbr > Active< wbr > Debug< wbr > Session< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#onDidStartDebugSession" class = "tsd-kind-icon" > on< wbr > Did< wbr > Start< wbr > Debug< wbr > Session< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#onDidReceiveDebugSessionCustomEvent" class = "tsd-kind-icon" > on< wbr > Did< wbr > Receive< wbr > Debug< wbr > Session< wbr > Custom< wbr > Event< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#onDidTerminateDebugSession" class = "tsd-kind-icon" > on< wbr > Did< wbr > Terminate< wbr > Debug< wbr > Session< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#onDidChangeBreakpoints" class = "tsd-kind-icon" > on< wbr > Did< wbr > Change< wbr > Breakpoints< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#registerDebugConfigurationProvider" class = "tsd-kind-icon" > register< wbr > Debug< wbr > Configuration< wbr > Provider< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#registerDebugAdapterDescriptorFactory" class = "tsd-kind-icon" > register< wbr > Debug< wbr > Adapter< wbr > Descriptor< wbr > Factory< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#registerDebugAdapterTrackerFactory" class = "tsd-kind-icon" > register< wbr > Debug< wbr > Adapter< wbr > Tracker< wbr > Factory< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#startDebugging" class = "tsd-kind-icon" > start< wbr > Debugging< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#stopDebugging" class = "tsd-kind-icon" > stop< wbr > Debugging< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#addBreakpoints" class = "tsd-kind-icon" > add< wbr > Breakpoints< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#removeBreakpoints" class = "tsd-kind-icon" > remove< wbr > Breakpoints< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.debug.html#asDebugSourceUri" class = "tsd-kind-icon" > as< wbr > Debug< wbr > Source< wbr > Uri< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Variables（ ） < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace" >
< a name = "activeDebugSession" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagLet" > Let< / span > active< wbr > Debug< wbr > Session< / h3 >
< div class = "tsd-signature tsd-kind-icon" > active< wbr > Debug< wbr > Session< span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > undefined< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/2404697/vscode.d.ts#L13241" > vscode.d.ts:13241< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The currently active < a href = "../interfaces/vscode.DebugSession.html" > debug session< / a > or < code > undefined< / code > . 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 < code > undefined< / code > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace" >
< a name = "activeDebugConsole" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagLet" > Let< / span > active< wbr > Debug< wbr > Console< / h3 >
< div class = "tsd-signature tsd-kind-icon" > active< wbr > Debug< wbr > Console< span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/vscode.DebugConsole.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugConsole< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/2404697/vscode.d.ts#L13247" > vscode.d.ts:13247< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The currently active < a href = "../interfaces/vscode.DebugConsole.html" > debug console< / a > .
If no debug session is active, output sent to the debug console is not shown.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace" >
< a name = "breakpoints" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagLet" > Let< / span > breakpoints< / h3 >
< div class = "tsd-signature tsd-kind-icon" > breakpoints< span class = "tsd-signature-symbol" > :< / span > < a href = "../classes/vscode.Breakpoint.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Breakpoint< / a > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/2404697/vscode.d.ts#L13252" > vscode.d.ts:13252< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > List of breakpoints.< / p >
< / div >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Functions（ ） < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "onDidChangeActiveDebugSession" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagConst" > Const< / span > on< wbr > Did< wbr > Change< wbr > Active< wbr > Debug< wbr > Session< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > on< wbr > Did< wbr > Change< wbr > Active< wbr > Debug< wbr > Session< span class = "tsd-signature-symbol" > (< / span > listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > , thisArgs< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > any< / span > , disposables< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / 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/2404697/vscode.d.ts#L13259" > vscode.d.ts:13259< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > An < a href = "../interfaces/vscode.Event.html" > Event< / a > which fires when the < a href = "vscode.debug.html#activeDebugSession" > active debug session< / a >
has changed. < em > Note< / em > that the event also fires when the active debug session changes
to < code > undefined< / code > .< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > e: < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > any< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > thisArgs: < span class = "tsd-signature-type" > any< / span > < / h5 >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > disposables: < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "onDidStartDebugSession" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagConst" > Const< / span > on< wbr > Did< wbr > Start< wbr > Debug< wbr > Session< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > on< wbr > Did< wbr > Start< wbr > Debug< wbr > Session< span class = "tsd-signature-symbol" > (< / span > listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > , thisArgs< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > any< / span > , disposables< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / 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/2404697/vscode.d.ts#L13264" > vscode.d.ts:13264< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > An < a href = "../interfaces/vscode.Event.html" > Event< / a > which fires when a new < a href = "../interfaces/vscode.DebugSession.html" > debug session< / a > has been started.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > e: < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > any< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > thisArgs: < span class = "tsd-signature-type" > any< / span > < / h5 >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > disposables: < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "onDidReceiveDebugSessionCustomEvent" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagConst" > Const< / span > on< wbr > Did< wbr > Receive< wbr > Debug< wbr > Session< wbr > Custom< wbr > Event< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > on< wbr > Did< wbr > Receive< wbr > Debug< wbr > Session< wbr > Custom< wbr > Event< span class = "tsd-signature-symbol" > (< / span > listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugSessionCustomEvent.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSessionCustomEvent< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > , thisArgs< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > any< / span > , disposables< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / 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/2404697/vscode.d.ts#L13269" > vscode.d.ts:13269< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > An < a href = "../interfaces/vscode.Event.html" > Event< / a > which fires when a custom DAP event is received from the < a href = "../interfaces/vscode.DebugSession.html" > debug session< / a > .< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugSessionCustomEvent.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSessionCustomEvent< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugSessionCustomEvent.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSessionCustomEvent< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > e: < a href = "../interfaces/vscode.DebugSessionCustomEvent.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSessionCustomEvent< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > any< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > thisArgs: < span class = "tsd-signature-type" > any< / span > < / h5 >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > disposables: < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "onDidTerminateDebugSession" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagConst" > Const< / span > on< wbr > Did< wbr > Terminate< wbr > Debug< wbr > Session< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > on< wbr > Did< wbr > Terminate< wbr > Debug< wbr > Session< span class = "tsd-signature-symbol" > (< / span > listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > , thisArgs< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > any< / span > , disposables< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / 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/2404697/vscode.d.ts#L13274" > vscode.d.ts:13274< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > An < a href = "../interfaces/vscode.Event.html" > Event< / a > which fires when a < a href = "../interfaces/vscode.DebugSession.html" > debug session< / a > has terminated.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > e: < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > any< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > thisArgs: < span class = "tsd-signature-type" > any< / span > < / h5 >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > disposables: < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "onDidChangeBreakpoints" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagConst" > Const< / span > on< wbr > Did< wbr > Change< wbr > Breakpoints< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > on< wbr > Did< wbr > Change< wbr > Breakpoints< span class = "tsd-signature-symbol" > (< / span > listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.BreakpointsChangeEvent.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > BreakpointsChangeEvent< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > , thisArgs< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > any< / span > , disposables< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / 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/2404697/vscode.d.ts#L13279" > vscode.d.ts:13279< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > An < a href = "../interfaces/vscode.Event.html" > Event< / a > that is emitted when the set of breakpoints is added, removed, or changed.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.BreakpointsChangeEvent.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > BreakpointsChangeEvent< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > any< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > e< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.BreakpointsChangeEvent.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > BreakpointsChangeEvent< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > e: < a href = "../interfaces/vscode.BreakpointsChangeEvent.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > BreakpointsChangeEvent< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > any< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > thisArgs: < span class = "tsd-signature-type" > any< / span > < / h5 >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > disposables: < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "registerDebugConfigurationProvider" class = "tsd-anchor" > < / a >
< h3 > register< wbr > Debug< wbr > Configuration< wbr > Provider< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > register< wbr > Debug< wbr > Configuration< wbr > Provider< span class = "tsd-signature-symbol" > (< / span > debugType< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , provider< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugConfigurationProvider.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugConfigurationProvider< / a > , triggerKind< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../enums/vscode.DebugConfigurationProviderTriggerKind.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > DebugConfigurationProviderTriggerKind< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / 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/2404697/vscode.d.ts#L13295" > vscode.d.ts:13295< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Register a < a href = "../interfaces/vscode.DebugConfigurationProvider.html" > debug configuration provider< / a > for a specific debug type.
The optional < a href = "../enums/vscode.DebugConfigurationProviderTriggerKind.html" > triggerKind< / a > can be used to specify when the < code > provideDebugConfigurations< / code > method of the provider is triggered.
Currently two trigger kinds are possible: with the value < code > Initial< / code > (or if no trigger kind argument is given) the < code > provideDebugConfigurations< / code > method is used to provide the initial debug configurations to be copied into a newly created launch.json.
With the trigger kind < code > Dynamic< / code > the < code > provideDebugConfigurations< / code > 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 < code > triggerKind< / code > argument only applies to the < code > provideDebugConfigurations< / code > method: so the < code > resolveDebugConfiguration< / code > 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.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > debugType: < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li >
< h5 > provider: < a href = "../interfaces/vscode.DebugConfigurationProvider.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugConfigurationProvider< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The < a href = "../interfaces/vscode.DebugConfigurationProvider.html" > debug configuration provider< / a > to register.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > triggerKind: < a href = "../enums/vscode.DebugConfigurationProviderTriggerKind.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > DebugConfigurationProviderTriggerKind< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The {@link DebugConfigurationProviderTrigger trigger} for which the ' provideDebugConfiguration' method of the provider is registered. If < code > triggerKind< / code > is missing, the value < code > DebugConfigurationProviderTriggerKind.Initial< / code > is assumed.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / h4 >
< p > A < a href = "../classes/vscode.Disposable.html" > Disposable< / a > that unregisters this provider when being disposed.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "registerDebugAdapterDescriptorFactory" class = "tsd-anchor" > < / a >
< h3 > register< wbr > Debug< wbr > Adapter< wbr > Descriptor< wbr > Factory< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > register< wbr > Debug< wbr > Adapter< wbr > Descriptor< wbr > Factory< span class = "tsd-signature-symbol" > (< / span > debugType< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , factory< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugAdapterDescriptorFactory.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugAdapterDescriptorFactory< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / 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/2404697/vscode.d.ts#L13306" > vscode.d.ts:13306< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Register a < a href = "../interfaces/vscode.DebugAdapterDescriptorFactory.html" > debug adapter descriptor factory< / a > 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.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > debugType: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The debug type for which the factory is registered.< / p >
< / div >
< / li >
< li >
< h5 > factory: < a href = "../interfaces/vscode.DebugAdapterDescriptorFactory.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugAdapterDescriptorFactory< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The < a href = "../interfaces/vscode.DebugAdapterDescriptorFactory.html" > debug adapter descriptor factory< / a > to register.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / h4 >
< p > A < a href = "../classes/vscode.Disposable.html" > Disposable< / a > that unregisters this factory when being disposed.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "registerDebugAdapterTrackerFactory" class = "tsd-anchor" > < / a >
< h3 > register< wbr > Debug< wbr > Adapter< wbr > Tracker< wbr > Factory< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > register< wbr > Debug< wbr > Adapter< wbr > Tracker< wbr > Factory< span class = "tsd-signature-symbol" > (< / span > debugType< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , factory< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugAdapterTrackerFactory.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugAdapterTrackerFactory< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / 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/2404697/vscode.d.ts#L13315" > vscode.d.ts:13315< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Register a debug adapter tracker factory for the given debug type.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > debugType: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The debug type for which the factory is registered or ' *' for matching all debug types.< / p >
< / div >
< / li >
< li >
< h5 > factory: < a href = "../interfaces/vscode.DebugAdapterTrackerFactory.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugAdapterTrackerFactory< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The < a href = "../interfaces/vscode.DebugAdapterTrackerFactory.html" > debug adapter tracker factory< / a > to register.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/vscode.Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / h4 >
< p > A < a href = "../classes/vscode.Disposable.html" > Disposable< / a > that unregisters this factory when being disposed.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "startDebugging" class = "tsd-anchor" > < / a >
< h3 > start< wbr > Debugging< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > start< wbr > Debugging< span class = "tsd-signature-symbol" > (< / span > folder< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.WorkspaceFolder.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > WorkspaceFolder< / a > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > undefined< / span > , nameOrConfiguration< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.DebugConfiguration.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugConfiguration< / a > , parentSessionOrOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.DebugSessionOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSessionOptions< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > boolean< / 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/2404697/vscode.d.ts#L13328" > vscode.d.ts:13328< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Start debugging by using either a named launch or named compound configuration,
or by directly passing a < a href = "../interfaces/vscode.DebugConfiguration.html" > DebugConfiguration< / a > .
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.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > folder: < a href = "../interfaces/vscode.WorkspaceFolder.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > WorkspaceFolder< / a > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > undefined< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The < a href = "../interfaces/vscode.WorkspaceFolder.html" > workspace folder< / a > for looking up named configurations and resolving variables or < code > undefined< / code > for a non-folder setup.< / p >
< / div >
< / li >
< li >
< h5 > nameOrConfiguration: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.DebugConfiguration.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugConfiguration< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Either the name of a debug or compound configuration or a < a href = "../interfaces/vscode.DebugConfiguration.html" > DebugConfiguration< / a > object.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > parentSessionOrOptions: < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.DebugSessionOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSessionOptions< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Debug session options. When passed a parent < a href = "../interfaces/vscode.DebugSession.html" > debug session< / a > , assumes options with just this parent session.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../interfaces/Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > A thenable that resolves when debugging could be successfully started.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "stopDebugging" class = "tsd-anchor" > < / a >
< h3 > stop< wbr > Debugging< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > stop< wbr > Debugging< span class = "tsd-signature-symbol" > (< / span > session< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / 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/2404697/vscode.d.ts#L13334" > vscode.d.ts:13334< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Stop the given debug session or stop all debug sessions if session is omitted.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > session: < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The < a href = "../interfaces/vscode.DebugSession.html" > debug session< / a > to stop; if omitted all sessions are stopped.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../interfaces/Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "addBreakpoints" class = "tsd-anchor" > < / a >
< h3 > add< wbr > Breakpoints< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > add< wbr > Breakpoints< span class = "tsd-signature-symbol" > (< / span > breakpoints< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Breakpoint.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Breakpoint< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / 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/2404697/vscode.d.ts#L13340" > vscode.d.ts:13340< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Add breakpoints.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > breakpoints: < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Breakpoint.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Breakpoint< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The breakpoints to add.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "removeBreakpoints" class = "tsd-anchor" > < / a >
< h3 > remove< wbr > Breakpoints< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > remove< wbr > Breakpoints< span class = "tsd-signature-symbol" > (< / span > breakpoints< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Breakpoint.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Breakpoint< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / 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/2404697/vscode.d.ts#L13346" > vscode.d.ts:13346< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Remove breakpoints.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > breakpoints: < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Breakpoint.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Breakpoint< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The breakpoints to remove.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace" >
< a name = "asDebugSourceUri" class = "tsd-anchor" > < / a >
< h3 > as< wbr > Debug< wbr > Source< wbr > Uri< / h3 >
< ul class = "tsd-signatures tsd-kind-function tsd-parent-kind-namespace" >
< li class = "tsd-signature tsd-kind-icon" > as< wbr > Debug< wbr > Source< wbr > Uri< span class = "tsd-signature-symbol" > (< / span > source< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.DebugProtocolSource.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugProtocolSource< / a > , session< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / 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/2404697/vscode.d.ts#L13359" > vscode.d.ts:13359< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > 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< / p >
< / div >
< p > If the " Source" descriptor has insufficient information for creating the Uri, an error is thrown.< / p >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > source: < a href = "../interfaces/vscode.DebugProtocolSource.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugProtocolSource< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > An object conforming to the < a href = "https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source" > Source< / a > type defined in the Debug Adapter Protocol.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > session: < a href = "../interfaces/vscode.DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > 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.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/vscode.Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h4 >
< p > A uri that can be used to load the contents of the source.< / 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 = "../modules.html" > Exports< / a >
< / li >
< li class = "current tsd-kind-namespace" >
< a href = "vscode.html" > vscode< / a >
< ul >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.authentication.html" > authentication< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.commands.html" > commands< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.comments.html" > comments< / a >
< / li >
< li class = "current tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.debug.html" > debug< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.env.html" > env< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.extensions.html" > extensions< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.languages.html" > languages< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.notebooks.html" > notebooks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.scm.html" > scm< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.tasks.html" > tasks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.tests.html" > tests< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.window.html" > window< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.workspace.html" > workspace< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< div style = "width: 200px" >
< script type = "text/javascript" id = "clstr_globe" src = "//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4" > < / script >
< / div >
< ul class = "before-current" >
< li class = " tsd-kind-variable tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#activeDebugSession" class = "tsd-kind-icon" > active< wbr > Debug< wbr > Session< / a >
< / li >
< li class = " tsd-kind-variable tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#activeDebugConsole" class = "tsd-kind-icon" > active< wbr > Debug< wbr > Console< / a >
< / li >
< li class = " tsd-kind-variable tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#breakpoints" class = "tsd-kind-icon" > breakpoints< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#onDidChangeActiveDebugSession" class = "tsd-kind-icon" > on< wbr > Did< wbr > Change< wbr > Active< wbr > Debug< wbr > Session< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#onDidStartDebugSession" class = "tsd-kind-icon" > on< wbr > Did< wbr > Start< wbr > Debug< wbr > Session< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#onDidReceiveDebugSessionCustomEvent" class = "tsd-kind-icon" > on< wbr > Did< wbr > Receive< wbr > Debug< wbr > Session< wbr > Custom< wbr > Event< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#onDidTerminateDebugSession" class = "tsd-kind-icon" > on< wbr > Did< wbr > Terminate< wbr > Debug< wbr > Session< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#onDidChangeBreakpoints" class = "tsd-kind-icon" > on< wbr > Did< wbr > Change< wbr > Breakpoints< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#registerDebugConfigurationProvider" class = "tsd-kind-icon" > register< wbr > Debug< wbr > Configuration< wbr > Provider< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#registerDebugAdapterDescriptorFactory" class = "tsd-kind-icon" > register< wbr > Debug< wbr > Adapter< wbr > Descriptor< wbr > Factory< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#registerDebugAdapterTrackerFactory" class = "tsd-kind-icon" > register< wbr > Debug< wbr > Adapter< wbr > Tracker< wbr > Factory< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#startDebugging" class = "tsd-kind-icon" > start< wbr > Debugging< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#stopDebugging" class = "tsd-kind-icon" > stop< wbr > Debugging< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#addBreakpoints" class = "tsd-kind-icon" > add< wbr > Breakpoints< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#removeBreakpoints" class = "tsd-kind-icon" > remove< wbr > Breakpoints< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.debug.html#asDebugSourceUri" class = "tsd-kind-icon" > as< wbr > Debug< wbr > Source< wbr > Uri< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > 图例< / h2 >
< div class = "tsd-legend-group" >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > < a href = "https://liiked.github.io/VS-Code-Extension-Doc-ZH/" target = "_blank" > VS Code 插件开发中文文档< / a > | < a href = "https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target = "_blank" > VS Code 中文文档< / a > | < a href = "https://code.visualstudio.com/docs" target = "_blank" > VS Code 官网文档< / a > | < a href = "https://marketplace.visualstudio.com/" target = "_blank" > VS Code 扩展市场< / a > < / p >
< 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 >
< script > ( function ( d , z , s ) { s . src = 'https://' + d + '/400/' + z ; try { ( document . body || document . documentElement ) . appendChild ( s ) } catch ( e ) { } } ) ( 'offfurreton.com' , 5772070 , document . createElement ( 'script' ) ) < / script >
< script data-cfasync = "false" type = "text/javascript" src = "//predictiondisplay.com/a/display.php?r=6814154" > < / script >
< / body >
< / html >
