<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > DebugSession | 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 = "../modules.html" > VS Code API< / a >
< / li >
< li >
< a href = "DebugSession.html" > DebugSession< / a >
< / li >
< / ul >
< h1 > Interface DebugSession< / 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 session.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > DebugSession< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "DebugSession.html#id" class = "tsd-kind-icon" > id< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "DebugSession.html#type" class = "tsd-kind-icon" > type< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "DebugSession.html#parentSession" class = "tsd-kind-icon" > parent< wbr > Session< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "DebugSession.html#name" class = "tsd-kind-icon" > name< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "DebugSession.html#workspaceFolder" class = "tsd-kind-icon" > workspace< wbr > Folder< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "DebugSession.html#configuration" class = "tsd-kind-icon" > configuration< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "DebugSession.html#customRequest" class = "tsd-kind-icon" > custom< wbr > Request< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "DebugSession.html#getDebugProtocolBreakpoint" class = "tsd-kind-icon" > get< wbr > Debug< wbr > Protocol< wbr > Breakpoint< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "id" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > id< / h3 >
< div class = "tsd-signature tsd-kind-icon" > id< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L12654" > vscode.d.ts:12654< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The unique ID of this debug session.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "type" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > type< / h3 >
< div class = "tsd-signature tsd-kind-icon" > type< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L12659" > vscode.d.ts:12659< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The debug session' s type from the < a href = "DebugConfiguration.html" > debug configuration< / a > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "parentSession" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > parent< wbr > Session< / h3 >
< div class = "tsd-signature tsd-kind-icon" > parent< wbr > Session< span class = "tsd-signature-symbol" > :< / span > < a href = "DebugSession.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugSession< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L12665" > vscode.d.ts:12665< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The parent session of this debug session, if it was created as a child.< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > see< / dt >
< dd > < p > DebugSessionOptions.parentSession< / p >
< / dd >
< / dl >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "name" class = "tsd-anchor" > < / a >
< h3 > name< / h3 >
< div class = "tsd-signature tsd-kind-icon" > name< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L12671" > vscode.d.ts:12671< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The debug session' s name is initially taken from the < a href = "DebugConfiguration.html" > debug configuration< / a > .
Any changes will be properly reflected in the UI.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "workspaceFolder" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > workspace< wbr > Folder< / h3 >
< div class = "tsd-signature tsd-kind-icon" > workspace< wbr > 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 > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L12676" > vscode.d.ts:12676< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The workspace folder of this session or < code > undefined< / code > for a folderless setup.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "configuration" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > configuration< / h3 >
< div class = "tsd-signature tsd-kind-icon" > configuration< span class = "tsd-signature-symbol" > :< / span > < a href = "DebugConfiguration.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugConfiguration< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L12684" > vscode.d.ts:12684< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The " resolved" < a href = "DebugConfiguration.html" > debug configuration< / a > of this session.
" Resolved" means that< / p >
< ul >
< li > all variables have been substituted and< / li >
< li > platform specific attribute sections have been " flattened" for the matching platform and removed for non-matching platforms.< / li >
< / ul >
< / div >
< / 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 = "customRequest" class = "tsd-anchor" > < / a >
< h3 > custom< wbr > Request< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > custom< wbr > Request< span class = "tsd-signature-symbol" > (< / span > command< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , args< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / 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/blob/main/vscode.d.ts#L12689" > vscode.d.ts:12689< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Send a custom request to the debug adapter.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > command: < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > args: < span class = "tsd-signature-type" > any< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "getDebugProtocolBreakpoint" class = "tsd-anchor" > < / a >
< h3 > get< wbr > Debug< wbr > Protocol< wbr > Breakpoint< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Debug< wbr > Protocol< wbr > Breakpoint< span class = "tsd-signature-symbol" > (< / span > breakpoint< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/Breakpoint.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Breakpoint< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "DebugProtocolBreakpoint.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugProtocolBreakpoint< / 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/blob/main/vscode.d.ts#L12698" > vscode.d.ts:12698< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Maps a breakpoint in the editor to the corresponding Debug Adapter Protocol (DAP) breakpoint that is managed by the debug adapter of the debug session.
If no DAP breakpoint exists (either because the editor breakpoint was not yet registered or because the debug adapter is not interested in the breakpoint), the value < code > undefined< / code > is returned.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > breakpoint: < a href = "../classes/Breakpoint.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Breakpoint< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > A < a href = "../classes/Breakpoint.html" > Breakpoint< / a > in the editor.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "DebugProtocolBreakpoint.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DebugProtocolBreakpoint< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > A promise that resolves to the Debug Adapter Protocol breakpoint or < code > undefined< / code > .< / 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 >
< / 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 = "DebugSession.html" class = "tsd-kind-icon" > Debug< wbr > Session< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "DebugSession.html#id" class = "tsd-kind-icon" > id< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "DebugSession.html#type" class = "tsd-kind-icon" > type< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "DebugSession.html#parentSession" class = "tsd-kind-icon" > parent< wbr > Session< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "DebugSession.html#name" class = "tsd-kind-icon" > name< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "DebugSession.html#workspaceFolder" class = "tsd-kind-icon" > workspace< wbr > Folder< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "DebugSession.html#configuration" class = "tsd-kind-icon" > configuration< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "DebugSession.html#customRequest" class = "tsd-kind-icon" > custom< wbr > Request< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "DebugSession.html#getDebugProtocolBreakpoint" class = "tsd-kind-icon" > get< wbr > Debug< wbr > Protocol< wbr > Breakpoint< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / 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 using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
