<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > DebugAdapterDescriptorFactory | 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 = "DebugAdapterDescriptorFactory.html" > DebugAdapterDescriptorFactory< / a >
< / li >
< / ul >
< h1 > Interface DebugAdapterDescriptorFactory< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > DebugAdapterDescriptorFactory< / 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 = "DebugAdapterDescriptorFactory.html#createDebugAdapterDescriptor" class = "tsd-kind-icon" > create< wbr > Debug< wbr > Adapter< wbr > Descriptor< / 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 = "createDebugAdapterDescriptor" class = "tsd-anchor" > < / a >
< h3 > create< wbr > Debug< wbr > Adapter< wbr > Descriptor< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > create< wbr > Debug< wbr > Adapter< wbr > Descriptor< span class = "tsd-signature-symbol" > (< / span > session< span class = "tsd-signature-symbol" > : < / span > < a href = "DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > , executable< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/DebugAdapterExecutable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DebugAdapterExecutable< / 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 = "../index.html#DebugAdapterDescriptor" class = "tsd-signature-type" data-tsd-kind = "Type alias" > DebugAdapterDescriptor< / 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/3b6f147/vscode.d.ts#L12906" > vscode.d.ts:12906< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > ' createDebugAdapterDescriptor' is called at the start of a debug session to provide details about the debug adapter to use.
These details must be returned as objects of type < a href = "../index.html#DebugAdapterDescriptor" > DebugAdapterDescriptor< / a > .
Currently two types of debug adapters are supported:< / p >
< ul >
< li > a debug adapter executable is specified as a command path and arguments (see < a href = "../classes/DebugAdapterExecutable.html" > DebugAdapterExecutable< / a > ),< / li >
< li > a debug adapter server reachable via a communication port (see < a href = "../classes/DebugAdapterServer.html" > DebugAdapterServer< / a > ).
If the method is not implemented the default behavior is this:
createDebugAdapter(session: DebugSession, executable: DebugAdapterExecutable) {
if (typeof session.configuration.debugServer === ' number' ) {< pre > < code > < span style = "color: #000000" > < / span > < span style = "color: #AF00DB" > return< / span > < span style = "color: #000000" > < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > DebugAdapterServer< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > session< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > configuration< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > debugServer< / span > < span style = "color: #000000" > );< / span >
< / code > < / pre >
}
return executable;
}< / li >
< / ul >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > session: < a href = "DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The < a href = "DebugSession.html" > debug session< / a > for which the debug adapter will be used.< / p >
< / div >
< / li >
< li >
< h5 > executable: < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/DebugAdapterExecutable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DebugAdapterExecutable< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The debug adapter' s executable information as specified in the package.json (or undefined if no such information exists).< / 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 = "../index.html#DebugAdapterDescriptor" class = "tsd-signature-type" data-tsd-kind = "Type alias" > DebugAdapterDescriptor< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > a < a href = "../index.html#DebugAdapterDescriptor" > debug adapter descriptor< / a > or undefined.< / 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 = "DebugAdapterDescriptorFactory.html" class = "tsd-kind-icon" > Debug< wbr > Adapter< wbr > Descriptor< wbr > Factory< / a >
< ul >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "DebugAdapterDescriptorFactory.html#createDebugAdapterDescriptor" class = "tsd-kind-icon" > create< wbr > Debug< wbr > Adapter< wbr > Descriptor< / 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 >
