<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Specification</title>
<meta name="description" content="Debug Adapter Protocol documentation and specification page.
">
<!-- link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta.2/css/bootstrap.min.css" integrity="sha384-PsH8R72JQ3SOdhVi3uxftmaW6Vc51MKb0q5P2rRUpPvrszuE4W1povHYgTpBfshb" crossorigin="anonymous" -->
<link rel="stylesheet" href="/debug-adapter-protocol/css/bootswatch/cosmo/bootstrap.min.css">
<link rel="stylesheet" href="/debug-adapter-protocol/css/fontawesome-all.min.css">
<link rel="stylesheet" href="/debug-adapter-protocol/css/main.css">
<link rel="shortcut icon" href="/debug-adapter-protocol/img/favicon.png">
<link rel="canonical" href="https://microsoft.github.io/debug-adapter-protocol//specification.html">
<link rel="alternate" type="application/rss+xml" title="Official page for Debug Adapter Protocol" href="https://microsoft.github.io/debug-adapter-protocol//debug-adapter-protocol/feed.xml" />
</head>
<body>
<div id="cookie-banner"></div>
<header class="navbar navbar-expand-lg navbar-dark bg-primary dap-navbar">
<div class="container navbar-container">
<a class="navbar-brand" href="/debug-adapter-protocol/">
<h1>DAP</h1>
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="navbar-collapse collapse" id="navbarSupportedContent" role="navigation" aria-label="Top Level">
<ul class="navbar-nav ml-auto">
<li class="nav-item">
<a class="nav-link" href="/debug-adapter-protocol/overview">Overview</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/debug-adapter-protocol/implementors/adapters/">Implementations</a>
</li>
<li class="nav-item active">
<a class="nav-link" href="/debug-adapter-protocol/specification">Specification</a>
</li>
</ul>
</div>
</div>
</header>
<div class="page-content">
<div class="wrapper">
<div class="container">
<div class="row single-page">
<div class="d-none col-lg-2 d-lg-block">
</div>
<div class="col-lg-7" role="navigation" aria-label="Main">
<h1>Debug Adapter Protocol</h1>
<div class="d-block d-lg-none dap-sidebar">
<div class="card">
<div id="outlineAccordion-inline" data-children=".item">
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-inline" href="#Base_Protocol-inline" aria-expanded="true">
Base Protocol
</a>
<div id="Base_Protocol-inline" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_Cancel">
Cancel
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_ErrorResponse">
ErrorResponse
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_Event">
Event
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_ProtocolMessage">
ProtocolMessage
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_Request">
Request
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_Response">
Response
</a>
</li>
</ul>
</div>
</div>
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-inline" href="#Events-inline" aria-expanded="true">
Events
</a>
<div id="Events-inline" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Breakpoint">
Breakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Capabilities">
Capabilities
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Continued">
Continued
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Exited">
Exited
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Initialized">
Initialized
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Invalidated">
Invalidated
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_LoadedSource">
LoadedSource
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Memory">
Memory
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Module">
Module
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Output">
Output
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Process">
Process
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_ProgressEnd">
ProgressEnd
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_ProgressStart">
ProgressStart
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_ProgressUpdate">
ProgressUpdate
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Stopped">
Stopped
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Terminated">
Terminated
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Thread">
Thread
</a>
</li>
</ul>
</div>
</div>
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-inline" href="#Requests-inline" aria-expanded="true">
Requests
</a>
<div id="Requests-inline" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Attach">
Attach
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_BreakpointLocations">
BreakpointLocations
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Completions">
Completions
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_ConfigurationDone">
ConfigurationDone
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Continue">
Continue
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_DataBreakpointInfo">
DataBreakpointInfo
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Disassemble">
Disassemble
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Disconnect">
Disconnect
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Evaluate">
Evaluate
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_ExceptionInfo">
ExceptionInfo
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Goto">
Goto
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_GotoTargets">
GotoTargets
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Initialize">
Initialize
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Launch">
Launch
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_LoadedSources">
LoadedSources
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Locations">
Locations
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Modules">
Modules
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Next">
Next
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Pause">
Pause
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_ReadMemory">
ReadMemory
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Restart">
Restart
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_RestartFrame">
RestartFrame
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_ReverseContinue">
ReverseContinue
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Scopes">
Scopes
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetBreakpoints">
SetBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetDataBreakpoints">
SetDataBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetExceptionBreakpoints">
SetExceptionBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetExpression">
SetExpression
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetFunctionBreakpoints">
SetFunctionBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetInstructionBreakpoints">
SetInstructionBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetVariable">
SetVariable
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Source">
Source
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StackTrace">
StackTrace
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StepBack">
StepBack
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StepIn">
StepIn
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StepInTargets">
StepInTargets
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StepOut">
StepOut
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Terminate">
Terminate
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_TerminateThreads">
TerminateThreads
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Threads">
Threads
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Variables">
Variables
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_WriteMemory">
WriteMemory
</a>
</li>
</ul>
</div>
</div>
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-inline" href="#Reverse_Requests-inline" aria-expanded="true">
Reverse Requests
</a>
<div id="Reverse_Requests-inline" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Reverse_Requests_RunInTerminal">
RunInTerminal
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Reverse_Requests_StartDebugging">
StartDebugging
</a>
</li>
</ul>
</div>
</div>
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-inline" href="#Types-inline" aria-expanded="true">
Types
</a>
<div id="Types-inline" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Breakpoint">
Breakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_BreakpointLocation">
BreakpointLocation
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_BreakpointMode">
BreakpointMode
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_BreakpointModeApplicability">
BreakpointModeApplicability
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Capabilities">
Capabilities
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Checksum">
Checksum
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ChecksumAlgorithm">
ChecksumAlgorithm
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ColumnDescriptor">
ColumnDescriptor
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_CompletionItem">
CompletionItem
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_CompletionItemType">
CompletionItemType
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_DataBreakpoint">
DataBreakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_DataBreakpointAccessType">
DataBreakpointAccessType
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_DisassembledInstruction">
DisassembledInstruction
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionBreakMode">
ExceptionBreakMode
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionBreakpointsFilter">
ExceptionBreakpointsFilter
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionDetails">
ExceptionDetails
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionFilterOptions">
ExceptionFilterOptions
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionOptions">
ExceptionOptions
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionPathSegment">
ExceptionPathSegment
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_FunctionBreakpoint">
FunctionBreakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_GotoTarget">
GotoTarget
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_InstructionBreakpoint">
InstructionBreakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_InvalidatedAreas">
InvalidatedAreas
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Message">
Message
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Module">
Module
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Scope">
Scope
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Source">
Source
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_SourceBreakpoint">
SourceBreakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_StackFrame">
StackFrame
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_StackFrameFormat">
StackFrameFormat
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_StepInTarget">
StepInTarget
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_SteppingGranularity">
SteppingGranularity
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Thread">
Thread
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ValueFormat">
ValueFormat
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Variable">
Variable
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_VariablePresentationHint">
VariablePresentationHint
</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div id="markdown-content-container">
<!--- Auto-generated from json schema. Do not edit! -->
<p>The Debug Adapter Protocol defines the protocol used between an editor or IDE and a debugger or runtime.</p>
<p>A machine-readable JSON schema can be found <a href="/debug-adapter-protocol/debugAdapterProtocol.json">here</a>.</p>
<p>The change history of the specification lives <a href="./changelog">here</a>.</p>
<h2 id="base-protocol">
<a name="Base_Protocol" class="anchor"></a>Base Protocol</h2>
<h3 id="protocolmessage">
<a name="Base_Protocol_ProtocolMessage" class="anchor"></a>ProtocolMessage</h3>
<p>Base class of requests, responses, and events.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ProtocolMessage</span> <span class="p">{</span>
<span class="cm">/**
* Sequence number of the message (also known as message ID). The `seq` for
* the first message sent by a client or debug adapter is 1, and for each
* subsequent message is 1 greater than the previous message sent by that
* actor. `seq` can be used to order requests, responses, and events, and to
* associate requests with their corresponding responses. For protocol
* messages of type `request` the sequence number can be used to cancel the
* request.
*/</span>
<span class="nl">seq</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Message type.
* Values: 'request', 'response', 'event', etc.
*/</span>
<span class="nl">type</span><span class="p">:</span> <span class="dl">'</span><span class="s1">request</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">response</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">event</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="request">
<a name="Base_Protocol_Request" class="anchor"></a>Request</h3>
<p>A client or debug adapter initiated request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Request</span> <span class="kd">extends</span> <span class="nx">ProtocolMessage</span> <span class="p">{</span>
<span class="nl">type</span><span class="p">:</span> <span class="dl">'</span><span class="s1">request</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* The command to execute.
*/</span>
<span class="nl">command</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Object containing arguments for the command.
*/</span>
<span class="nl">arguments</span><span class="p">?:</span> <span class="kr">any</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="event">
<a name="Base_Protocol_Event" class="anchor"></a>Event</h3>
<p>A debug adapter initiated event.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Event</span> <span class="kd">extends</span> <span class="nx">ProtocolMessage</span> <span class="p">{</span>
<span class="nl">type</span><span class="p">:</span> <span class="dl">'</span><span class="s1">event</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* Type of event.
*/</span>
<span class="nl">event</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Event-specific information.
*/</span>
<span class="nl">body</span><span class="p">?:</span> <span class="kr">any</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="response">
<a name="Base_Protocol_Response" class="anchor"></a>Response</h3>
<p>Response for a request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Response</span> <span class="kd">extends</span> <span class="nx">ProtocolMessage</span> <span class="p">{</span>
<span class="nl">type</span><span class="p">:</span> <span class="dl">'</span><span class="s1">response</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* Sequence number of the corresponding request.
*/</span>
<span class="nl">request_seq</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Outcome of the request.
* If true, the request was successful and the `body` attribute may contain
* the result of the request.
* If the value is false, the attribute `message` contains the error in short
* form and the `body` may contain additional information (see
* `ErrorResponse.body.error`).
*/</span>
<span class="nl">success</span><span class="p">:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The command requested.
*/</span>
<span class="nl">command</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Contains the raw error in short form if `success` is false.
* This raw error might be interpreted by the client and is not shown in the
* UI.
* Some predefined values exist.
* Values:
* 'cancelled': the request was cancelled.
* 'notStopped': the request may be retried once the adapter is in a 'stopped'
* state.
* etc.
*/</span>
<span class="nl">message</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">cancelled</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">notStopped</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Contains request result if success is true and error details if success is
* false.
*/</span>
<span class="nl">body</span><span class="p">?:</span> <span class="kr">any</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="errorresponse">
<a name="Base_Protocol_ErrorResponse" class="anchor"></a>ErrorResponse</h3>
<p>On error (whenever <code class="language-plaintext highlighter-rouge">success</code> is false), the body can provide more details.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ErrorResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* A structured error message.
*/</span>
<span class="nx">error</span><span class="p">?:</span> <span class="nx">Message</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-cancel-request">
<a name="Base_Protocol_Cancel" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Cancel Request</h3>
<p>The <code class="language-plaintext highlighter-rouge">cancel</code> request is used by the client in two situations:</p>
<ul>
<li>to indicate that it is no longer interested in the result produced by a specific request issued earlier</li>
<li>to cancel a progress sequence.</li>
</ul>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsCancelRequest</code> is true.</p>
<p>This request has a hint characteristic: a debug adapter can only be expected to make a ‘best effort’ in honoring this request but there are no guarantees.</p>
<p>The <code class="language-plaintext highlighter-rouge">cancel</code> request may return an error if it could not cancel an operation but a client should refrain from presenting this error to end users.</p>
<p>The request that got cancelled still needs to send a response back. This can either be a normal result (<code class="language-plaintext highlighter-rouge">success</code> attribute true) or an error response (<code class="language-plaintext highlighter-rouge">success</code> attribute false and the <code class="language-plaintext highlighter-rouge">message</code> set to <code class="language-plaintext highlighter-rouge">cancelled</code>).</p>
<p>Returning partial results from a cancelled request is possible but please note that a client has no generic way for detecting that a response is partial or not.</p>
<p>The progress that got cancelled still needs to send a <code class="language-plaintext highlighter-rouge">progressEnd</code> event back.</p>
<p>A client should not assume that progress just got cancelled after sending the <code class="language-plaintext highlighter-rouge">cancel</code> request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">CancelRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">cancel</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">?:</span> <span class="nx">CancelArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">cancel</code> request.</p>
<p><a name="Types_CancelArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">CancelArguments</span> <span class="p">{</span>
<span class="cm">/**
* The ID (attribute `seq`) of the request to cancel. If missing no request is
* cancelled.
* Both a `requestId` and a `progressId` can be specified in one request.
*/</span>
<span class="nl">requestId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The ID (attribute `progressId`) of the progress to cancel. If missing no
* progress is cancelled.
* Both a `requestId` and a `progressId` can be specified in one request.
*/</span>
<span class="nl">progressId</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">cancel</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_CancelResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">CancelResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h2 id="events">
<a name="Events" class="anchor"></a>Events</h2>
<h3 id="arrow_left-initialized-event">
<a name="Events_Initialized" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Initialized Event</h3>
<p>This event indicates that the debug adapter is ready to accept configuration requests (e.g. <code class="language-plaintext highlighter-rouge">setBreakpoints</code>, <code class="language-plaintext highlighter-rouge">setExceptionBreakpoints</code>).</p>
<p>A debug adapter is expected to send this event when it is ready to accept configuration requests (but not before the <code class="language-plaintext highlighter-rouge">initialize</code> request has finished).</p>
<p>The sequence of events/requests is as follows:</p>
<ul>
<li>adapters sends <code class="language-plaintext highlighter-rouge">initialized</code> event (after the <code class="language-plaintext highlighter-rouge">initialize</code> request has returned)</li>
<li>client sends zero or more <code class="language-plaintext highlighter-rouge">setBreakpoints</code> requests</li>
<li>client sends one <code class="language-plaintext highlighter-rouge">setFunctionBreakpoints</code> request (if corresponding capability <code class="language-plaintext highlighter-rouge">supportsFunctionBreakpoints</code> is true)</li>
<li>client sends a <code class="language-plaintext highlighter-rouge">setExceptionBreakpoints</code> request if one or more <code class="language-plaintext highlighter-rouge">exceptionBreakpointFilters</code> have been defined (or if <code class="language-plaintext highlighter-rouge">supportsConfigurationDoneRequest</code> is not true)</li>
<li>client sends other future configuration requests</li>
<li>client sends one <code class="language-plaintext highlighter-rouge">configurationDone</code> request to indicate the end of the configuration.</li>
</ul>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">InitializedEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">initialized</span><span class="dl">'</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-stopped-event">
<a name="Events_Stopped" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Stopped Event</h3>
<p>The event indicates that the execution of the debuggee has stopped due to some condition.</p>
<p>This can be caused by a breakpoint previously set, a stepping request has completed, by executing a debugger statement etc.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StoppedEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">stopped</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The reason for the event.
* For backward compatibility this string is shown in the UI if the
* `description` attribute is missing (but it must not be translated).
* Values: 'step', 'breakpoint', 'exception', 'pause', 'entry', 'goto',
* 'function breakpoint', 'data breakpoint', 'instruction breakpoint', etc.
*/</span>
<span class="na">reason</span><span class="p">:</span> <span class="dl">'</span><span class="s1">step</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">breakpoint</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">exception</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">pause</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">entry</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">goto</span><span class="dl">'</span>
<span class="o">|</span> <span class="dl">'</span><span class="s1">function breakpoint</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">data breakpoint</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">instruction breakpoint</span><span class="dl">'</span>
<span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The full reason for the event, e.g. 'Paused on exception'. This string is
* shown in the UI as is and can be translated.
*/</span>
<span class="nl">description</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The thread which was stopped.
*/</span>
<span class="nl">threadId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A value of true hints to the client that this event should not change the
* focus.
*/</span>
<span class="nl">preserveFocusHint</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Additional information. E.g. if reason is `exception`, text contains the
* exception name. This string is shown in the UI.
*/</span>
<span class="nl">text</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* If `allThreadsStopped` is true, a debug adapter can announce that all
* threads have stopped.
* - The client should use this information to enable that all threads can
* be expanded to access their stacktraces.
* - If the attribute is missing or false, only the thread with the given
* `threadId` can be expanded.
*/</span>
<span class="nl">allThreadsStopped</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Ids of the breakpoints that triggered the event. In most cases there is
* only a single breakpoint but here are some examples for multiple
* breakpoints:
* - Different types of breakpoints map to the same location.
* - Multiple source breakpoints get collapsed to the same instruction by
* the compiler/runtime.
* - Multiple function breakpoints with different function names map to the
* same location.
*/</span>
<span class="nl">hitBreakpointIds</span><span class="p">?:</span> <span class="kr">number</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-continued-event">
<a name="Events_Continued" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Continued Event</h3>
<p>The event indicates that the execution of the debuggee has continued.</p>
<p>Please note: a debug adapter is not expected to send this event in response to a request that implies that execution continues, e.g. <code class="language-plaintext highlighter-rouge">launch</code> or <code class="language-plaintext highlighter-rouge">continue</code>.</p>
<p>It is only necessary to send a <code class="language-plaintext highlighter-rouge">continued</code> event if there was no previous request that implied this.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ContinuedEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">continued</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The thread which was continued.
*/</span>
<span class="na">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If omitted or set to `true`, this event signals to the client that all
* threads have been resumed. The value `false` indicates that not all
* threads were resumed.
*/</span>
<span class="nl">allThreadsContinued</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-exited-event">
<a name="Events_Exited" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Exited Event</h3>
<p>The event indicates that the debuggee has exited and returns its exit code.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ExitedEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">exited</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The exit code returned from the debuggee.
*/</span>
<span class="na">exitCode</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-terminated-event">
<a name="Events_Terminated" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Terminated Event</h3>
<p>The event indicates that debugging of the debuggee has terminated. This does <strong>not</strong> mean that the debuggee itself has exited.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">TerminatedEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">terminated</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">?:</span> <span class="p">{</span>
<span class="cm">/**
* A debug adapter may set `restart` to true (or to an arbitrary object) to
* request that the client restarts the session.
* The value is not interpreted by the client and passed unmodified as an
* attribute `__restart` to the `launch` and `attach` requests.
*/</span>
<span class="nx">restart</span><span class="p">?:</span> <span class="kr">any</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-thread-event">
<a name="Events_Thread" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Thread Event</h3>
<p>The event indicates that a thread has started or exited.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ThreadEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">thread</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The reason for the event.
* Values: 'started', 'exited', etc.
*/</span>
<span class="na">reason</span><span class="p">:</span> <span class="dl">'</span><span class="s1">started</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">exited</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The identifier of the thread.
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-output-event">
<a name="Events_Output" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Output Event</h3>
<p>The event indicates that the target has produced some output.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">OutputEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">output</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The output category. If not specified or if the category is not
* understood by the client, `console` is assumed.
* Values:
* 'console': Show the output in the client's default message UI, e.g. a
* 'debug console'. This category should only be used for informational
* output from the debugger (as opposed to the debuggee).
* 'important': A hint for the client to show the output in the client's UI
* for important and highly visible information, e.g. as a popup
* notification. This category should only be used for important messages
* from the debugger (as opposed to the debuggee). Since this category value
* is a hint, clients might ignore the hint and assume the `console`
* category.
* 'stdout': Show the output as normal program output from the debuggee.
* 'stderr': Show the output as error program output from the debuggee.
* 'telemetry': Send the output to telemetry instead of showing it to the
* user.
* etc.
*/</span>
<span class="nx">category</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">console</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">important</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">stdout</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">stderr</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">telemetry</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The output to report.
*
* ANSI escape sequences may be used to influence text color and styling if
* `supportsANSIStyling` is present in both the adapter's `Capabilities` and
* the client's `InitializeRequestArguments`. A client may strip any
* unrecognized ANSI sequences.
*
* If the `supportsANSIStyling` capabilities are not both true, then the
* client should display the output literally.
*/</span>
<span class="nl">output</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Support for keeping an output log organized by grouping related messages.
* Values:
* 'start': Start a new group in expanded mode. Subsequent output events are
* members of the group and should be shown indented.
* The `output` attribute becomes the name of the group and is not indented.
* 'startCollapsed': Start a new group in collapsed mode. Subsequent output
* events are members of the group and should be shown indented (as soon as
* the group is expanded).
* The `output` attribute becomes the name of the group and is not indented.
* 'end': End the current group and decrease the indentation of subsequent
* output events.
* A non-empty `output` attribute is shown as the unindented end of the
* group.
*/</span>
<span class="nl">group</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">start</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">startCollapsed</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">end</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* If an attribute `variablesReference` exists and its value is > 0, the
* output contains objects which can be retrieved by passing
* `variablesReference` to the `variables` request as long as execution
* remains suspended. See 'Lifetime of Object References' in the Overview
* section for details.
*/</span>
<span class="nl">variablesReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The source location where the output was produced.
*/</span>
<span class="nl">source</span><span class="p">?:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The source location's line where the output was produced.
*/</span>
<span class="nl">line</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The position in `line` where the output was produced. It is measured in
* UTF-16 code units and the client capability `columnsStartAt1` determines
* whether it is 0- or 1-based.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Additional data to report. For the `telemetry` category the data is sent
* to telemetry, for the other categories the data is shown in JSON format.
*/</span>
<span class="nl">data</span><span class="p">?:</span> <span class="kr">any</span><span class="p">;</span>
<span class="cm">/**
* A reference that allows the client to request the location where the new
* value is declared. For example, if the logged value is function pointer,
* the adapter may be able to look up the function's location. This should
* be present only if the adapter is likely to be able to resolve the
* location.
*
* This reference shares the same lifetime as the `variablesReference`. See
* 'Lifetime of Object References' in the Overview section for details.
*/</span>
<span class="nl">locationReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-breakpoint-event">
<a name="Events_Breakpoint" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Breakpoint Event</h3>
<p>The event indicates that some information about a breakpoint has changed.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">BreakpointEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">breakpoint</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The reason for the event.
* Values: 'changed', 'new', 'removed', etc.
*/</span>
<span class="na">reason</span><span class="p">:</span> <span class="dl">'</span><span class="s1">changed</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">new</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">removed</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The `id` attribute is used to find the target breakpoint, the other
* attributes are used as the new values.
*/</span>
<span class="nl">breakpoint</span><span class="p">:</span> <span class="nx">Breakpoint</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-module-event">
<a name="Events_Module" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Module Event</h3>
<p>The event indicates that some information about a module has changed.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ModuleEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">module</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The reason for the event.
* Values: 'new', 'changed', 'removed'
*/</span>
<span class="na">reason</span><span class="p">:</span> <span class="dl">'</span><span class="s1">new</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">changed</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">removed</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* The new, changed, or removed module. In case of `removed` only the module
* id is used.
*/</span>
<span class="nl">module</span><span class="p">:</span> <span class="nx">Module</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-loadedsource-event">
<a name="Events_LoadedSource" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> LoadedSource Event</h3>
<p>The event indicates that some source has been added, changed, or removed from the set of all loaded sources.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LoadedSourceEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">loadedSource</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The reason for the event.
* Values: 'new', 'changed', 'removed'
*/</span>
<span class="na">reason</span><span class="p">:</span> <span class="dl">'</span><span class="s1">new</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">changed</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">removed</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* The new, changed, or removed source.
*/</span>
<span class="nl">source</span><span class="p">:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-process-event">
<a name="Events_Process" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Process Event</h3>
<p>The event indicates that the debugger has begun debugging a new process. Either one that it has launched, or one that it has attached to.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ProcessEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">process</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The logical name of the process. This is usually the full path to
* process's executable file. Example: /home/example/myproj/program.js.
*/</span>
<span class="na">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The process ID of the debugged process, as assigned by the operating
* system. This property should be omitted for logical processes that do not
* map to operating system processes on the machine.
*/</span>
<span class="nl">systemProcessId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If true, the process is running on the same computer as the debug
* adapter.
*/</span>
<span class="nl">isLocalProcess</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Describes how the debug engine started debugging this process.
* Values:
* 'launch': Process was launched under the debugger.
* 'attach': Debugger attached to an existing process.
* 'attachForSuspendedLaunch': A project launcher component has launched a
* new process in a suspended state and then asked the debugger to attach.
*/</span>
<span class="nl">startMethod</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">launch</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">attach</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">attachForSuspendedLaunch</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* The size of a pointer or address for this process, in bits. This value
* may be used by clients when formatting addresses for display.
*/</span>
<span class="nl">pointerSize</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-capabilities-event">
<a name="Events_Capabilities" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Capabilities Event</h3>
<p>The event indicates that one or more capabilities have changed.</p>
<p>Since the capabilities are dependent on the client and its UI, it might not be possible to change that at random times (or too late).</p>
<p>Consequently this event has a hint characteristic: a client can only be expected to make a ‘best effort’ in honoring individual capabilities but there are no guarantees.</p>
<p>Only changed capabilities need to be included, all other capabilities keep their values.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">CapabilitiesEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">capabilities</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The set of updated capabilities.
*/</span>
<span class="na">capabilities</span><span class="p">:</span> <span class="nx">Capabilities</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-progressstart-event">
<a name="Events_ProgressStart" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> ProgressStart Event</h3>
<p>The event signals that a long running operation is about to start and provides additional information for the client to set up a corresponding progress and cancellation UI.</p>
<p>The client is free to delay the showing of the UI in order to reduce flicker.</p>
<p>This event should only be sent if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsProgressReporting</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ProgressStartEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">progressStart</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* An ID that can be used in subsequent `progressUpdate` and `progressEnd`
* events to make them refer to the same progress reporting.
* IDs must be unique within a debug session.
*/</span>
<span class="na">progressId</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Short title of the progress reporting. Shown in the UI to describe the
* long running operation.
*/</span>
<span class="nl">title</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The request ID that this progress report is related to. If specified a
* debug adapter is expected to emit progress events for the long running
* request until the request has been either completed or cancelled.
* If the request ID is omitted, the progress report is assumed to be
* related to some general activity of the debug adapter.
*/</span>
<span class="nl">requestId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If true, the request that reports progress may be cancelled with a
* `cancel` request.
* So this property basically controls whether the client should use UX that
* supports cancellation.
* Clients that don't support cancellation are allowed to ignore the
* setting.
*/</span>
<span class="nl">cancellable</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* More detailed progress message.
*/</span>
<span class="nl">message</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Progress percentage to display (value range: 0 to 100). If omitted no
* percentage is shown.
*/</span>
<span class="nl">percentage</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-progressupdate-event">
<a name="Events_ProgressUpdate" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> ProgressUpdate Event</h3>
<p>The event signals that the progress reporting needs to be updated with a new message and/or percentage.</p>
<p>The client does not have to update the UI immediately, but the clients needs to keep track of the message and/or percentage values.</p>
<p>This event should only be sent if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsProgressReporting</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ProgressUpdateEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">progressUpdate</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The ID that was introduced in the initial `progressStart` event.
*/</span>
<span class="na">progressId</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* More detailed progress message. If omitted, the previous message (if any)
* is used.
*/</span>
<span class="nl">message</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Progress percentage to display (value range: 0 to 100). If omitted no
* percentage is shown.
*/</span>
<span class="nl">percentage</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-progressend-event">
<a name="Events_ProgressEnd" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> ProgressEnd Event</h3>
<p>The event signals the end of the progress reporting with a final message.</p>
<p>This event should only be sent if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsProgressReporting</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ProgressEndEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">progressEnd</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The ID that was introduced in the initial `ProgressStartEvent`.
*/</span>
<span class="na">progressId</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* More detailed progress message. If omitted, the previous message (if any)
* is used.
*/</span>
<span class="nl">message</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-invalidated-event">
<a name="Events_Invalidated" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Invalidated Event</h3>
<p>This event signals that some state in the debug adapter has changed and requires that the client needs to re-render the data snapshot previously requested.</p>
<p>Debug adapters do not have to emit this event for runtime changes like stopped or thread events because in that case the client refetches the new state anyway. But the event can be used for example to refresh the UI after rendering formatting has changed in the debug adapter.</p>
<p>This event should only be sent if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsInvalidatedEvent</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">InvalidatedEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">invalidated</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* Set of logical areas that got invalidated. This property has a hint
* characteristic: a client can only be expected to make a 'best effort' in
* honoring the areas but there are no guarantees. If this property is
* missing, empty, or if values are not understood, the client should assume
* a single value `all`.
*/</span>
<span class="nx">areas</span><span class="p">?:</span> <span class="nx">InvalidatedAreas</span><span class="p">[];</span>
<span class="cm">/**
* If specified, the client only needs to refetch data related to this
* thread.
*/</span>
<span class="nl">threadId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If specified, the client only needs to refetch data related to this stack
* frame (and the `threadId` is ignored).
*/</span>
<span class="nl">stackFrameId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="arrow_left-memory-event">
<a name="Events_Memory" class="anchor"></a><img class="emoji" title=":arrow_left:" alt=":arrow_left:" src="https://github.githubassets.com/images/icons/emoji/unicode/2b05.png" height="20" width="20"> Memory Event</h3>
<p>This event indicates that some memory range has been updated. It should only be sent if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsMemoryEvent</code> is true.</p>
<p>Clients typically react to the event by re-issuing a <code class="language-plaintext highlighter-rouge">readMemory</code> request if they show the memory identified by the <code class="language-plaintext highlighter-rouge">memoryReference</code> and if the updated memory range overlaps the displayed range. Clients should not make assumptions how individual memory references relate to each other, so they should not assume that they are part of a single continuous address range and might overlap.</p>
<p>Debug adapters can use this event to indicate that the contents of a memory range has changed due to some other request like <code class="language-plaintext highlighter-rouge">setVariable</code> or <code class="language-plaintext highlighter-rouge">setExpression</code>. Debug adapters are not expected to emit this event for each and every memory change of a running program, because that information is typically not available from debuggers and it would flood clients with too many events.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">MemoryEvent</span> <span class="kd">extends</span> <span class="nx">Event</span> <span class="p">{</span>
<span class="nl">event</span><span class="p">:</span> <span class="dl">'</span><span class="s1">memory</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* Memory reference of a memory range that has been updated.
*/</span>
<span class="na">memoryReference</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Starting offset in bytes where memory has been updated. Can be negative.
*/</span>
<span class="nl">offset</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Number of bytes updated.
*/</span>
<span class="nl">count</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h2 id="reverse-requests">
<a name="Reverse_Requests" class="anchor"></a>Reverse Requests</h2>
<h3 id="arrow_right_hook-runinterminal-request">
<a name="Reverse_Requests_RunInTerminal" class="anchor"></a><img class="emoji" title=":arrow_right_hook:" alt=":arrow_right_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21aa.png" height="20" width="20"> RunInTerminal Request</h3>
<p>This request is sent from the debug adapter to the client to run a command in a terminal.</p>
<p>This is typically used to launch the debuggee in a terminal provided by the client.</p>
<p>This request should only be called if the corresponding client capability <code class="language-plaintext highlighter-rouge">supportsRunInTerminalRequest</code> is true.</p>
<p>Client implementations of <code class="language-plaintext highlighter-rouge">runInTerminal</code> are free to run the command however they choose including issuing the command to a command line interpreter (aka ‘shell’). Argument strings passed to the <code class="language-plaintext highlighter-rouge">runInTerminal</code> request must arrive verbatim in the command to be run. As a consequence, clients which use a shell are responsible for escaping any special shell characters in the argument strings to prevent them from being interpreted (and modified) by the shell.</p>
<p>Some users may wish to take advantage of shell processing in the argument strings. For clients which implement <code class="language-plaintext highlighter-rouge">runInTerminal</code> using an intermediary shell, the <code class="language-plaintext highlighter-rouge">argsCanBeInterpretedByShell</code> property can be set to true. In this case the client is requested not to escape any special shell characters in the argument strings.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">RunInTerminalRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">runInTerminal</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">RunInTerminalRequestArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">runInTerminal</code> request.</p>
<p><a name="Types_RunInTerminalRequestArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">RunInTerminalRequestArguments</span> <span class="p">{</span>
<span class="cm">/**
* What kind of terminal to launch. Defaults to `integrated` if not specified.
* Values: 'integrated', 'external'
*/</span>
<span class="nl">kind</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">integrated</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">external</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* Title of the terminal.
*/</span>
<span class="nl">title</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Working directory for the command. For non-empty, valid paths this
* typically results in execution of a change directory command.
*/</span>
<span class="nl">cwd</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* List of arguments. The first argument is the command to run.
*/</span>
<span class="nl">args</span><span class="p">:</span> <span class="kr">string</span><span class="p">[];</span>
<span class="cm">/**
* Environment key-value pairs that are added to or removed from the default
* environment.
*/</span>
<span class="nl">env</span><span class="p">?:</span> <span class="p">{</span> <span class="p">[</span><span class="na">key</span><span class="p">:</span> <span class="kr">string</span><span class="p">]:</span> <span class="kr">string</span> <span class="o">|</span> <span class="kc">null</span><span class="p">;</span> <span class="p">};</span>
<span class="cm">/**
* This property should only be set if the corresponding capability
* `supportsArgsCanBeInterpretedByShell` is true. If the client uses an
* intermediary shell to launch the application, then the client must not
* attempt to escape characters with special meanings for the shell. The user
* is fully responsible for escaping as needed and that arguments using
* special characters may not be portable across shells.
*/</span>
<span class="nl">argsCanBeInterpretedByShell</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">runInTerminal</code> request.</p>
<p><a name="Types_RunInTerminalResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">RunInTerminalResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The process ID. The value should be less than or equal to 2147483647
* (2^31-1).
*/</span>
<span class="nx">processId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The process ID of the terminal shell. The value should be less than or
* equal to 2147483647 (2^31-1).
*/</span>
<span class="nl">shellProcessId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-startdebugging-request">
<a name="Reverse_Requests_StartDebugging" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> StartDebugging Request</h3>
<p>This request is sent from the debug adapter to the client to start a new debug session of the same type as the caller.</p>
<p>This request should only be sent if the corresponding client capability <code class="language-plaintext highlighter-rouge">supportsStartDebuggingRequest</code> is true.</p>
<p>A client implementation of <code class="language-plaintext highlighter-rouge">startDebugging</code> should start a new debug session (of the same type as the caller) in the same way that the caller’s session was started. If the client supports hierarchical debug sessions, the newly created session can be treated as a child of the caller session.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StartDebuggingRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">startDebugging</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">StartDebuggingRequestArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">startDebugging</code> request.</p>
<p><a name="Types_StartDebuggingRequestArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StartDebuggingRequestArguments</span> <span class="p">{</span>
<span class="cm">/**
* Arguments passed to the new debug session. The arguments must only contain
* properties understood by the `launch` or `attach` requests of the debug
* adapter and they must not contain any client-specific properties (e.g.
* `type`) or client-specific features (e.g. substitutable 'variables').
*/</span>
<span class="nl">configuration</span><span class="p">:</span> <span class="p">{</span> <span class="p">[</span><span class="na">key</span><span class="p">:</span> <span class="kr">string</span><span class="p">]:</span> <span class="kr">any</span><span class="p">;</span> <span class="p">};</span>
<span class="cm">/**
* Indicates whether the new debug session should be started with a `launch`
* or `attach` request.
* Values: 'launch', 'attach'
*/</span>
<span class="nl">request</span><span class="p">:</span> <span class="dl">'</span><span class="s1">launch</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">attach</span><span class="dl">'</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">startDebugging</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_StartDebuggingResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StartDebuggingResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h2 id="requests">
<a name="Requests" class="anchor"></a>Requests</h2>
<h3 id="leftwards_arrow_with_hook-initialize-request">
<a name="Requests_Initialize" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Initialize Request</h3>
<p>The <code class="language-plaintext highlighter-rouge">initialize</code> request is sent as the first request from the client to the debug adapter in order to configure it with client capabilities and to retrieve capabilities from the debug adapter.</p>
<p>Until the debug adapter has responded with an <code class="language-plaintext highlighter-rouge">initialize</code> response, the client must not send any additional requests or events to the debug adapter.</p>
<p>In addition the debug adapter is not allowed to send any requests or events to the client until it has responded with an <code class="language-plaintext highlighter-rouge">initialize</code> response.</p>
<p>The <code class="language-plaintext highlighter-rouge">initialize</code> request may only be sent once.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">InitializeRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">initialize</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">InitializeRequestArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">initialize</code> request.</p>
<p><a name="Types_InitializeRequestArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">InitializeRequestArguments</span> <span class="p">{</span>
<span class="cm">/**
* The ID of the client using this adapter.
*/</span>
<span class="nl">clientID</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The human-readable name of the client using this adapter.
*/</span>
<span class="nl">clientName</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The ID of the debug adapter.
*/</span>
<span class="nl">adapterID</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The ISO-639 locale of the client using this adapter, e.g. en-US or de-CH.
*/</span>
<span class="nl">locale</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* If true all line numbers are 1-based (default).
*/</span>
<span class="nl">linesStartAt1</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* If true all column numbers are 1-based (default).
*/</span>
<span class="nl">columnsStartAt1</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Determines in what format paths are specified. The default is `path`, which
* is the native format.
* Values: 'path', 'uri', etc.
*/</span>
<span class="nl">pathFormat</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">path</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">uri</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Client supports the `type` attribute for variables.
*/</span>
<span class="nl">supportsVariableType</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Client supports the paging of variables.
*/</span>
<span class="nl">supportsVariablePaging</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Client supports the `runInTerminal` request.
*/</span>
<span class="nl">supportsRunInTerminalRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Client supports memory references.
*/</span>
<span class="nl">supportsMemoryReferences</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Client supports progress reporting.
*/</span>
<span class="nl">supportsProgressReporting</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Client supports the `invalidated` event.
*/</span>
<span class="nl">supportsInvalidatedEvent</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Client supports the `memory` event.
*/</span>
<span class="nl">supportsMemoryEvent</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Client supports the `argsCanBeInterpretedByShell` attribute on the
* `runInTerminal` request.
*/</span>
<span class="nl">supportsArgsCanBeInterpretedByShell</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Client supports the `startDebugging` request.
*/</span>
<span class="nl">supportsStartDebuggingRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The client will interpret ANSI escape sequences in the display of
* `OutputEvent.output` and `Variable.value` fields when
* `Capabilities.supportsANSIStyling` is also enabled.
*/</span>
<span class="nl">supportsANSIStyling</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">initialize</code> request.</p>
<p><a name="Types_InitializeResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">InitializeResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="cm">/**
* The capabilities of this debug adapter.
*/</span>
<span class="nl">body</span><span class="p">?:</span> <span class="nx">Capabilities</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-configurationdone-request">
<a name="Requests_ConfigurationDone" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> ConfigurationDone Request</h3>
<p>This request indicates that the client has finished initialization of the debug adapter.</p>
<p>So it is the last request in the sequence of configuration requests (which was started by the <code class="language-plaintext highlighter-rouge">initialized</code> event).</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsConfigurationDoneRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ConfigurationDoneRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">configurationDone</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">?:</span> <span class="nx">ConfigurationDoneArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">configurationDone</code> request.</p>
<p><a name="Types_ConfigurationDoneArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ConfigurationDoneArguments</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">configurationDone</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_ConfigurationDoneResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ConfigurationDoneResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-launch-request">
<a name="Requests_Launch" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Launch Request</h3>
<p>This launch request is sent from the client to the debug adapter to start the debuggee with or without debugging (if <code class="language-plaintext highlighter-rouge">noDebug</code> is true).</p>
<p>Since launching is debugger/runtime specific, the arguments for this request are not part of this specification.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LaunchRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">launch</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">LaunchRequestArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">launch</code> request. Additional attributes are implementation specific.</p>
<p><a name="Types_LaunchRequestArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LaunchRequestArguments</span> <span class="p">{</span>
<span class="cm">/**
* If true, the launch request should launch the program without enabling
* debugging.
*/</span>
<span class="nl">noDebug</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Arbitrary data from the previous, restarted session.
* The data is sent as the `restart` attribute of the `terminated` event.
* The client should leave the data intact.
*/</span>
<span class="nl">__restart</span><span class="p">?:</span> <span class="kr">any</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">launch</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_LaunchResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LaunchResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-attach-request">
<a name="Requests_Attach" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Attach Request</h3>
<p>The <code class="language-plaintext highlighter-rouge">attach</code> request is sent from the client to the debug adapter to attach to a debuggee that is already running.</p>
<p>Since attaching is debugger/runtime specific, the arguments for this request are not part of this specification.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">AttachRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">attach</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">AttachRequestArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">attach</code> request. Additional attributes are implementation specific.</p>
<p><a name="Types_AttachRequestArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">AttachRequestArguments</span> <span class="p">{</span>
<span class="cm">/**
* Arbitrary data from the previous, restarted session.
* The data is sent as the `restart` attribute of the `terminated` event.
* The client should leave the data intact.
*/</span>
<span class="nl">__restart</span><span class="p">?:</span> <span class="kr">any</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">attach</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_AttachResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">AttachResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-restart-request">
<a name="Requests_Restart" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Restart Request</h3>
<p>Restarts a debug session. Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsRestartRequest</code> is true.</p>
<p>If the capability is missing or has the value false, a typical client emulates <code class="language-plaintext highlighter-rouge">restart</code> by terminating the debug adapter first and then launching it anew.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">RestartRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">restart</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">?:</span> <span class="nx">RestartArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">restart</code> request.</p>
<p><a name="Types_RestartArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">RestartArguments</span> <span class="p">{</span>
<span class="cm">/**
* The latest version of the `launch` or `attach` configuration.
*/</span>
<span class="nl">arguments</span><span class="p">?:</span> <span class="nx">LaunchRequestArguments</span> <span class="o">|</span> <span class="nx">AttachRequestArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">restart</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_RestartResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">RestartResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-disconnect-request">
<a name="Requests_Disconnect" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Disconnect Request</h3>
<p>The <code class="language-plaintext highlighter-rouge">disconnect</code> request asks the debug adapter to disconnect from the debuggee (thus ending the debug session) and then to shut down itself (the debug adapter).</p>
<p>In addition, the debug adapter must terminate the debuggee if it was started with the <code class="language-plaintext highlighter-rouge">launch</code> request. If an <code class="language-plaintext highlighter-rouge">attach</code> request was used to connect to the debuggee, then the debug adapter must not terminate the debuggee.</p>
<p>This implicit behavior of when to terminate the debuggee can be overridden with the <code class="language-plaintext highlighter-rouge">terminateDebuggee</code> argument (which is only supported by a debug adapter if the corresponding capability <code class="language-plaintext highlighter-rouge">supportTerminateDebuggee</code> is true).</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DisconnectRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">disconnect</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">?:</span> <span class="nx">DisconnectArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">disconnect</code> request.</p>
<p><a name="Types_DisconnectArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DisconnectArguments</span> <span class="p">{</span>
<span class="cm">/**
* A value of true indicates that this `disconnect` request is part of a
* restart sequence.
*/</span>
<span class="nl">restart</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Indicates whether the debuggee should be terminated when the debugger is
* disconnected.
* If unspecified, the debug adapter is free to do whatever it thinks is best.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportTerminateDebuggee` is true.
*/</span>
<span class="nl">terminateDebuggee</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Indicates whether the debuggee should stay suspended when the debugger is
* disconnected.
* If unspecified, the debuggee should resume execution.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportSuspendDebuggee` is true.
*/</span>
<span class="nl">suspendDebuggee</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">disconnect</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_DisconnectResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DisconnectResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-terminate-request">
<a name="Requests_Terminate" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Terminate Request</h3>
<p>The <code class="language-plaintext highlighter-rouge">terminate</code> request is sent from the client to the debug adapter in order to shut down the debuggee gracefully. Clients should only call this request if the capability <code class="language-plaintext highlighter-rouge">supportsTerminateRequest</code> is true.</p>
<p>Typically a debug adapter implements <code class="language-plaintext highlighter-rouge">terminate</code> by sending a software signal which the debuggee intercepts in order to clean things up properly before terminating itself.</p>
<p>Please note that this request does not directly affect the state of the debug session: if the debuggee decides to veto the graceful shutdown for any reason by not terminating itself, then the debug session just continues.</p>
<p>Clients can surface the <code class="language-plaintext highlighter-rouge">terminate</code> request as an explicit command or they can integrate it into a two stage Stop command that first sends <code class="language-plaintext highlighter-rouge">terminate</code> to request a graceful shutdown, and if that fails uses <code class="language-plaintext highlighter-rouge">disconnect</code> for a forceful shutdown.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">TerminateRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">terminate</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">?:</span> <span class="nx">TerminateArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">terminate</code> request.</p>
<p><a name="Types_TerminateArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">TerminateArguments</span> <span class="p">{</span>
<span class="cm">/**
* A value of true indicates that this `terminate` request is part of a
* restart sequence.
*/</span>
<span class="nl">restart</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">terminate</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_TerminateResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">TerminateResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-breakpointlocations-request">
<a name="Requests_BreakpointLocations" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> BreakpointLocations Request</h3>
<p>The <code class="language-plaintext highlighter-rouge">breakpointLocations</code> request returns all possible locations for source breakpoints in a given range.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsBreakpointLocationsRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">BreakpointLocationsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">breakpointLocations</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">?:</span> <span class="nx">BreakpointLocationsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">breakpointLocations</code> request.</p>
<p><a name="Types_BreakpointLocationsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">BreakpointLocationsArguments</span> <span class="p">{</span>
<span class="cm">/**
* The source location of the breakpoints; either `source.path` or
* `source.sourceReference` must be specified.
*/</span>
<span class="nl">source</span><span class="p">:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* Start line of range to search possible breakpoint locations in. If only the
* line is specified, the request returns all possible locations in that line.
*/</span>
<span class="nl">line</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Start position within `line` to search possible breakpoint locations in. It
* is measured in UTF-16 code units and the client capability
* `columnsStartAt1` determines whether it is 0- or 1-based. If no column is
* given, the first position in the start line is assumed.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* End line of range to search possible breakpoint locations in. If no end
* line is given, then the end line is assumed to be the start line.
*/</span>
<span class="nl">endLine</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* End position within `endLine` to search possible breakpoint locations in.
* It is measured in UTF-16 code units and the client capability
* `columnsStartAt1` determines whether it is 0- or 1-based. If no end column
* is given, the last position in the end line is assumed.
*/</span>
<span class="nl">endColumn</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">breakpointLocations</code> request.</p>
<p>Contains possible locations for source breakpoints.</p>
<p><a name="Types_BreakpointLocationsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">BreakpointLocationsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* Sorted set of possible breakpoint locations.
*/</span>
<span class="na">breakpoints</span><span class="p">:</span> <span class="nx">BreakpointLocation</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-setbreakpoints-request">
<a name="Requests_SetBreakpoints" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> SetBreakpoints Request</h3>
<p>Sets multiple breakpoints for a single source and clears all previous breakpoints in that source.</p>
<p>To clear all breakpoint for a source, specify an empty array.</p>
<p>When a breakpoint is hit, a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">breakpoint</code>) is generated.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetBreakpointsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">setBreakpoints</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">SetBreakpointsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">setBreakpoints</code> request.</p>
<p><a name="Types_SetBreakpointsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetBreakpointsArguments</span> <span class="p">{</span>
<span class="cm">/**
* The source location of the breakpoints; either `source.path` or
* `source.sourceReference` must be specified.
*/</span>
<span class="nl">source</span><span class="p">:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The code locations of the breakpoints.
*/</span>
<span class="nl">breakpoints</span><span class="p">?:</span> <span class="nx">SourceBreakpoint</span><span class="p">[];</span>
<span class="cm">/**
* Deprecated: The code locations of the breakpoints.
*/</span>
<span class="nl">lines</span><span class="p">?:</span> <span class="kr">number</span><span class="p">[];</span>
<span class="cm">/**
* A value of true indicates that the underlying source has been modified
* which results in new breakpoint locations.
*/</span>
<span class="nl">sourceModified</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">setBreakpoints</code> request.</p>
<p>Returned is information about each breakpoint created by this request.</p>
<p>This includes the actual code location and whether the breakpoint could be verified.</p>
<p>The breakpoints returned are in the same order as the elements of the <code class="language-plaintext highlighter-rouge">breakpoints</code></p>
<p>(or the deprecated <code class="language-plaintext highlighter-rouge">lines</code>) array in the arguments.</p>
<p><a name="Types_SetBreakpointsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetBreakpointsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* Information about the breakpoints.
* The array elements are in the same order as the elements of the
* `breakpoints` (or the deprecated `lines`) array in the arguments.
*/</span>
<span class="na">breakpoints</span><span class="p">:</span> <span class="nx">Breakpoint</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-setfunctionbreakpoints-request">
<a name="Requests_SetFunctionBreakpoints" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> SetFunctionBreakpoints Request</h3>
<p>Replaces all existing function breakpoints with new function breakpoints.</p>
<p>To clear all function breakpoints, specify an empty array.</p>
<p>When a function breakpoint is hit, a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">function breakpoint</code>) is generated.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsFunctionBreakpoints</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetFunctionBreakpointsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">setFunctionBreakpoints</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">SetFunctionBreakpointsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">setFunctionBreakpoints</code> request.</p>
<p><a name="Types_SetFunctionBreakpointsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetFunctionBreakpointsArguments</span> <span class="p">{</span>
<span class="cm">/**
* The function names of the breakpoints.
*/</span>
<span class="nl">breakpoints</span><span class="p">:</span> <span class="nx">FunctionBreakpoint</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">setFunctionBreakpoints</code> request.</p>
<p>Returned is information about each breakpoint created by this request.</p>
<p><a name="Types_SetFunctionBreakpointsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetFunctionBreakpointsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* Information about the breakpoints. The array elements correspond to the
* elements of the `breakpoints` array.
*/</span>
<span class="na">breakpoints</span><span class="p">:</span> <span class="nx">Breakpoint</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-setexceptionbreakpoints-request">
<a name="Requests_SetExceptionBreakpoints" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> SetExceptionBreakpoints Request</h3>
<p>The request configures the debugger’s response to thrown exceptions. Each of the <code class="language-plaintext highlighter-rouge">filters</code>, <code class="language-plaintext highlighter-rouge">filterOptions</code>, and <code class="language-plaintext highlighter-rouge">exceptionOptions</code> in the request are independent configurations to a debug adapter indicating a kind of exception to catch. An exception thrown in a program should result in a <code class="language-plaintext highlighter-rouge">stopped</code> event from the debug adapter (with reason <code class="language-plaintext highlighter-rouge">exception</code>) if any of the configured filters match.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">exceptionBreakpointFilters</code> returns one or more filters.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetExceptionBreakpointsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">setExceptionBreakpoints</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">SetExceptionBreakpointsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">setExceptionBreakpoints</code> request.</p>
<p><a name="Types_SetExceptionBreakpointsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetExceptionBreakpointsArguments</span> <span class="p">{</span>
<span class="cm">/**
* Set of exception filters specified by their ID. The set of all possible
* exception filters is defined by the `exceptionBreakpointFilters`
* capability. The `filter` and `filterOptions` sets are additive.
*/</span>
<span class="nl">filters</span><span class="p">:</span> <span class="kr">string</span><span class="p">[];</span>
<span class="cm">/**
* Set of exception filters and their options. The set of all possible
* exception filters is defined by the `exceptionBreakpointFilters`
* capability. This attribute is only honored by a debug adapter if the
* corresponding capability `supportsExceptionFilterOptions` is true. The
* `filter` and `filterOptions` sets are additive.
*/</span>
<span class="nl">filterOptions</span><span class="p">?:</span> <span class="nx">ExceptionFilterOptions</span><span class="p">[];</span>
<span class="cm">/**
* Configuration options for selected exceptions.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsExceptionOptions` is true.
*/</span>
<span class="nl">exceptionOptions</span><span class="p">?:</span> <span class="nx">ExceptionOptions</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">setExceptionBreakpoints</code> request.</p>
<p>The response contains an array of <code class="language-plaintext highlighter-rouge">Breakpoint</code> objects with information about each exception breakpoint or filter. The <code class="language-plaintext highlighter-rouge">Breakpoint</code> objects are in the same order as the elements of the <code class="language-plaintext highlighter-rouge">filters</code>, <code class="language-plaintext highlighter-rouge">filterOptions</code>, <code class="language-plaintext highlighter-rouge">exceptionOptions</code> arrays given as arguments. If both <code class="language-plaintext highlighter-rouge">filters</code> and <code class="language-plaintext highlighter-rouge">filterOptions</code> are given, the returned array must start with <code class="language-plaintext highlighter-rouge">filters</code> information first, followed by <code class="language-plaintext highlighter-rouge">filterOptions</code> information.</p>
<p>The <code class="language-plaintext highlighter-rouge">verified</code> property of a <code class="language-plaintext highlighter-rouge">Breakpoint</code> object signals whether the exception breakpoint or filter could be successfully created and whether the condition is valid. In case of an error the <code class="language-plaintext highlighter-rouge">message</code> property explains the problem. The <code class="language-plaintext highlighter-rouge">id</code> property can be used to introduce a unique ID for the exception breakpoint or filter so that it can be updated subsequently by sending breakpoint events.</p>
<p>For backward compatibility both the <code class="language-plaintext highlighter-rouge">breakpoints</code> array and the enclosing <code class="language-plaintext highlighter-rouge">body</code> are optional. If these elements are missing a client is not able to show problems for individual exception breakpoints or filters.</p>
<p><a name="Types_SetExceptionBreakpointsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetExceptionBreakpointsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">?:</span> <span class="p">{</span>
<span class="cm">/**
* Information about the exception breakpoints or filters.
* The breakpoints returned are in the same order as the elements of the
* `filters`, `filterOptions`, `exceptionOptions` arrays in the arguments.
* If both `filters` and `filterOptions` are given, the returned array must
* start with `filters` information first, followed by `filterOptions`
* information.
*/</span>
<span class="nx">breakpoints</span><span class="p">?:</span> <span class="nx">Breakpoint</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-databreakpointinfo-request">
<a name="Requests_DataBreakpointInfo" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> DataBreakpointInfo Request</h3>
<p>Obtains information on a possible data breakpoint that could be set on an expression or variable.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsDataBreakpoints</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DataBreakpointInfoRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">dataBreakpointInfo</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">DataBreakpointInfoArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">dataBreakpointInfo</code> request.</p>
<p><a name="Types_DataBreakpointInfoArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DataBreakpointInfoArguments</span> <span class="p">{</span>
<span class="cm">/**
* Reference to the variable container if the data breakpoint is requested for
* a child of the container. The `variablesReference` must have been obtained
* in the current suspended state. See 'Lifetime of Object References' in the
* Overview section for details.
*/</span>
<span class="nl">variablesReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The name of the variable's child to obtain data breakpoint information for.
* If `variablesReference` isn't specified, this can be an expression, or an
* address if `asAddress` is also true.
*/</span>
<span class="nl">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* When `name` is an expression, evaluate it in the scope of this stack frame.
* If not specified, the expression is evaluated in the global scope. When
* `variablesReference` is specified, this property has no effect.
*/</span>
<span class="nl">frameId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If specified, a debug adapter should return information for the range of
* memory extending `bytes` number of bytes from the address or variable
* specified by `name`. Breakpoints set using the resulting data ID should
* pause on data access anywhere within that range.
*
* Clients may set this property only if the `supportsDataBreakpointBytes`
* capability is true.
*/</span>
<span class="nl">bytes</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If `true`, the `name` is a memory address and the debugger should interpret
* it as a decimal value, or hex value if it is prefixed with `0x`.
*
* Clients may set this property only if the `supportsDataBreakpointBytes`
* capability is true.
*/</span>
<span class="nl">asAddress</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The mode of the desired breakpoint. If defined, this must be one of the
* `breakpointModes` the debug adapter advertised in its `Capabilities`.
*/</span>
<span class="nl">mode</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">dataBreakpointInfo</code> request.</p>
<p><a name="Types_DataBreakpointInfoResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DataBreakpointInfoResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* An identifier for the data on which a data breakpoint can be registered
* with the `setDataBreakpoints` request or null if no data breakpoint is
* available. If a `variablesReference` or `frameId` is passed, the `dataId`
* is valid in the current suspended state, otherwise it's valid
* indefinitely. See 'Lifetime of Object References' in the Overview section
* for details. Breakpoints set using the `dataId` in the
* `setDataBreakpoints` request may outlive the lifetime of the associated
* `dataId`.
*/</span>
<span class="na">dataId</span><span class="p">:</span> <span class="kr">string</span> <span class="o">|</span> <span class="kc">null</span><span class="p">;</span>
<span class="cm">/**
* UI string that describes on what data the breakpoint is set on or why a
* data breakpoint is not available.
*/</span>
<span class="nl">description</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Attribute lists the available access types for a potential data
* breakpoint. A UI client could surface this information.
*/</span>
<span class="nl">accessTypes</span><span class="p">?:</span> <span class="nx">DataBreakpointAccessType</span><span class="p">[];</span>
<span class="cm">/**
* Attribute indicates that a potential data breakpoint could be persisted
* across sessions.
*/</span>
<span class="nl">canPersist</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-setdatabreakpoints-request">
<a name="Requests_SetDataBreakpoints" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> SetDataBreakpoints Request</h3>
<p>Replaces all existing data breakpoints with new data breakpoints.</p>
<p>To clear all data breakpoints, specify an empty array.</p>
<p>When a data breakpoint is hit, a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">data breakpoint</code>) is generated.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsDataBreakpoints</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetDataBreakpointsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">setDataBreakpoints</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">SetDataBreakpointsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">setDataBreakpoints</code> request.</p>
<p><a name="Types_SetDataBreakpointsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetDataBreakpointsArguments</span> <span class="p">{</span>
<span class="cm">/**
* The contents of this array replaces all existing data breakpoints. An empty
* array clears all data breakpoints.
*/</span>
<span class="nl">breakpoints</span><span class="p">:</span> <span class="nx">DataBreakpoint</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">setDataBreakpoints</code> request.</p>
<p>Returned is information about each breakpoint created by this request.</p>
<p><a name="Types_SetDataBreakpointsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetDataBreakpointsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* Information about the data breakpoints. The array elements correspond to
* the elements of the input argument `breakpoints` array.
*/</span>
<span class="na">breakpoints</span><span class="p">:</span> <span class="nx">Breakpoint</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-setinstructionbreakpoints-request">
<a name="Requests_SetInstructionBreakpoints" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> SetInstructionBreakpoints Request</h3>
<p>Replaces all existing instruction breakpoints. Typically, instruction breakpoints would be set from a disassembly window.</p>
<p>To clear all instruction breakpoints, specify an empty array.</p>
<p>When an instruction breakpoint is hit, a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">instruction breakpoint</code>) is generated.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsInstructionBreakpoints</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetInstructionBreakpointsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">setInstructionBreakpoints</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">SetInstructionBreakpointsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">setInstructionBreakpoints</code> request</p>
<p><a name="Types_SetInstructionBreakpointsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetInstructionBreakpointsArguments</span> <span class="p">{</span>
<span class="cm">/**
* The instruction references of the breakpoints
*/</span>
<span class="nl">breakpoints</span><span class="p">:</span> <span class="nx">InstructionBreakpoint</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">setInstructionBreakpoints</code> request</p>
<p><a name="Types_SetInstructionBreakpointsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetInstructionBreakpointsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* Information about the breakpoints. The array elements correspond to the
* elements of the `breakpoints` array.
*/</span>
<span class="na">breakpoints</span><span class="p">:</span> <span class="nx">Breakpoint</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-continue-request">
<a name="Requests_Continue" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Continue Request</h3>
<p>The request resumes execution of all threads. If the debug adapter supports single thread execution (see capability <code class="language-plaintext highlighter-rouge">supportsSingleThreadExecutionRequests</code>), setting the <code class="language-plaintext highlighter-rouge">singleThread</code> argument to true resumes only the specified thread. If not all threads were resumed, the <code class="language-plaintext highlighter-rouge">allThreadsContinued</code> attribute of the response should be set to false.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ContinueRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">continue</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">ContinueArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">continue</code> request.</p>
<p><a name="Types_ContinueArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ContinueArguments</span> <span class="p">{</span>
<span class="cm">/**
* Specifies the active thread. If the debug adapter supports single thread
* execution (see `supportsSingleThreadExecutionRequests`) and the argument
* `singleThread` is true, only the thread with this ID is resumed.
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If this flag is true, execution is resumed only for the thread with given
* `threadId`.
*/</span>
<span class="nl">singleThread</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">continue</code> request.</p>
<p><a name="Types_ContinueResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ContinueResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* If omitted or set to `true`, this response signals to the client that all
* threads have been resumed. The value `false` indicates that not all
* threads were resumed.
*/</span>
<span class="nx">allThreadsContinued</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-next-request">
<a name="Requests_Next" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Next Request</h3>
<p>The request executes one step (in the given granularity) for the specified thread and allows all other threads to run freely by resuming them.</p>
<p>If the debug adapter supports single thread execution (see capability <code class="language-plaintext highlighter-rouge">supportsSingleThreadExecutionRequests</code>), setting the <code class="language-plaintext highlighter-rouge">singleThread</code> argument to true prevents other suspended threads from resuming.</p>
<p>The debug adapter first sends the response and then a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">step</code>) after the step has completed.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">NextRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">next</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">NextArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">next</code> request.</p>
<p><a name="Types_NextArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">NextArguments</span> <span class="p">{</span>
<span class="cm">/**
* Specifies the thread for which to resume execution for one step (of the
* given granularity).
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If this flag is true, all other suspended threads are not resumed.
*/</span>
<span class="nl">singleThread</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Stepping granularity. If no granularity is specified, a granularity of
* `statement` is assumed.
*/</span>
<span class="nl">granularity</span><span class="p">?:</span> <span class="nx">SteppingGranularity</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">next</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_NextResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">NextResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-stepin-request">
<a name="Requests_StepIn" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> StepIn Request</h3>
<p>The request resumes the given thread to step into a function/method and allows all other threads to run freely by resuming them.</p>
<p>If the debug adapter supports single thread execution (see capability <code class="language-plaintext highlighter-rouge">supportsSingleThreadExecutionRequests</code>), setting the <code class="language-plaintext highlighter-rouge">singleThread</code> argument to true prevents other suspended threads from resuming.</p>
<p>If the request cannot step into a target, <code class="language-plaintext highlighter-rouge">stepIn</code> behaves like the <code class="language-plaintext highlighter-rouge">next</code> request.</p>
<p>The debug adapter first sends the response and then a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">step</code>) after the step has completed.</p>
<p>If there are multiple function/method calls (or other targets) on the source line,</p>
<p>the argument <code class="language-plaintext highlighter-rouge">targetId</code> can be used to control into which target the <code class="language-plaintext highlighter-rouge">stepIn</code> should occur.</p>
<p>The list of possible targets for a given source line can be retrieved via the <code class="language-plaintext highlighter-rouge">stepInTargets</code> request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepInRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">stepIn</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">StepInArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">stepIn</code> request.</p>
<p><a name="Types_StepInArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepInArguments</span> <span class="p">{</span>
<span class="cm">/**
* Specifies the thread for which to resume execution for one step-into (of
* the given granularity).
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If this flag is true, all other suspended threads are not resumed.
*/</span>
<span class="nl">singleThread</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Id of the target to step into.
*/</span>
<span class="nl">targetId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Stepping granularity. If no granularity is specified, a granularity of
* `statement` is assumed.
*/</span>
<span class="nl">granularity</span><span class="p">?:</span> <span class="nx">SteppingGranularity</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">stepIn</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_StepInResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepInResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-stepout-request">
<a name="Requests_StepOut" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> StepOut Request</h3>
<p>The request resumes the given thread to step out (return) from a function/method and allows all other threads to run freely by resuming them.</p>
<p>If the debug adapter supports single thread execution (see capability <code class="language-plaintext highlighter-rouge">supportsSingleThreadExecutionRequests</code>), setting the <code class="language-plaintext highlighter-rouge">singleThread</code> argument to true prevents other suspended threads from resuming.</p>
<p>The debug adapter first sends the response and then a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">step</code>) after the step has completed.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepOutRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">stepOut</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">StepOutArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">stepOut</code> request.</p>
<p><a name="Types_StepOutArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepOutArguments</span> <span class="p">{</span>
<span class="cm">/**
* Specifies the thread for which to resume execution for one step-out (of the
* given granularity).
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If this flag is true, all other suspended threads are not resumed.
*/</span>
<span class="nl">singleThread</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Stepping granularity. If no granularity is specified, a granularity of
* `statement` is assumed.
*/</span>
<span class="nl">granularity</span><span class="p">?:</span> <span class="nx">SteppingGranularity</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">stepOut</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_StepOutResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepOutResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-stepback-request">
<a name="Requests_StepBack" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> StepBack Request</h3>
<p>The request executes one backward step (in the given granularity) for the specified thread and allows all other threads to run backward freely by resuming them.</p>
<p>If the debug adapter supports single thread execution (see capability <code class="language-plaintext highlighter-rouge">supportsSingleThreadExecutionRequests</code>), setting the <code class="language-plaintext highlighter-rouge">singleThread</code> argument to true prevents other suspended threads from resuming.</p>
<p>The debug adapter first sends the response and then a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">step</code>) after the step has completed.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsStepBack</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepBackRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">stepBack</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">StepBackArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">stepBack</code> request.</p>
<p><a name="Types_StepBackArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepBackArguments</span> <span class="p">{</span>
<span class="cm">/**
* Specifies the thread for which to resume execution for one step backwards
* (of the given granularity).
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If this flag is true, all other suspended threads are not resumed.
*/</span>
<span class="nl">singleThread</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Stepping granularity to step. If no granularity is specified, a granularity
* of `statement` is assumed.
*/</span>
<span class="nl">granularity</span><span class="p">?:</span> <span class="nx">SteppingGranularity</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">stepBack</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_StepBackResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepBackResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-reversecontinue-request">
<a name="Requests_ReverseContinue" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> ReverseContinue Request</h3>
<p>The request resumes backward execution of all threads. If the debug adapter supports single thread execution (see capability <code class="language-plaintext highlighter-rouge">supportsSingleThreadExecutionRequests</code>), setting the <code class="language-plaintext highlighter-rouge">singleThread</code> argument to true resumes only the specified thread. If not all threads were resumed, the <code class="language-plaintext highlighter-rouge">allThreadsContinued</code> attribute of the response should be set to false.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsStepBack</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ReverseContinueRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">reverseContinue</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">ReverseContinueArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">reverseContinue</code> request.</p>
<p><a name="Types_ReverseContinueArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ReverseContinueArguments</span> <span class="p">{</span>
<span class="cm">/**
* Specifies the active thread. If the debug adapter supports single thread
* execution (see `supportsSingleThreadExecutionRequests`) and the
* `singleThread` argument is true, only the thread with this ID is resumed.
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If this flag is true, backward execution is resumed only for the thread
* with given `threadId`.
*/</span>
<span class="nl">singleThread</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">reverseContinue</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_ReverseContinueResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ReverseContinueResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-restartframe-request">
<a name="Requests_RestartFrame" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> RestartFrame Request</h3>
<p>The request restarts execution of the specified stack frame.</p>
<p>The debug adapter first sends the response and then a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">restart</code>) after the restart has completed.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsRestartFrame</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">RestartFrameRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">restartFrame</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">RestartFrameArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">restartFrame</code> request.</p>
<p><a name="Types_RestartFrameArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">RestartFrameArguments</span> <span class="p">{</span>
<span class="cm">/**
* Restart the stack frame identified by `frameId`. The `frameId` must have
* been obtained in the current suspended state. See 'Lifetime of Object
* References' in the Overview section for details.
*/</span>
<span class="nl">frameId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">restartFrame</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_RestartFrameResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">RestartFrameResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-goto-request">
<a name="Requests_Goto" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Goto Request</h3>
<p>The request sets the location where the debuggee will continue to run.</p>
<p>This makes it possible to skip the execution of code or to execute code again.</p>
<p>The code between the current location and the goto target is not executed but skipped.</p>
<p>The debug adapter first sends the response and then a <code class="language-plaintext highlighter-rouge">stopped</code> event with reason <code class="language-plaintext highlighter-rouge">goto</code>.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsGotoTargetsRequest</code> is true (because only then goto targets exist that can be passed as arguments).</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">GotoRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">goto</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">GotoArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">goto</code> request.</p>
<p><a name="Types_GotoArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">GotoArguments</span> <span class="p">{</span>
<span class="cm">/**
* Set the goto target for this thread.
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The location where the debuggee will continue to run.
*/</span>
<span class="nl">targetId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">goto</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_GotoResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">GotoResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-pause-request">
<a name="Requests_Pause" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Pause Request</h3>
<p>The request suspends the debuggee.</p>
<p>The debug adapter first sends the response and then a <code class="language-plaintext highlighter-rouge">stopped</code> event (with reason <code class="language-plaintext highlighter-rouge">pause</code>) after the thread has been paused successfully.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">PauseRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">pause</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">PauseArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">pause</code> request.</p>
<p><a name="Types_PauseArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">PauseArguments</span> <span class="p">{</span>
<span class="cm">/**
* Pause execution for this thread.
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">pause</code> request. This is just an acknowledgement, so no body field is required.</p>
<p><a name="Types_PauseResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">PauseResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-stacktrace-request">
<a name="Requests_StackTrace" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> StackTrace Request</h3>
<p>The request returns a stacktrace from the current execution state of a given thread.</p>
<p>A client can request all stack frames by omitting the startFrame and levels arguments. For performance-conscious clients and if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsDelayedStackTraceLoading</code> is true, stack frames can be retrieved in a piecemeal way with the <code class="language-plaintext highlighter-rouge">startFrame</code> and <code class="language-plaintext highlighter-rouge">levels</code> arguments. The response of the <code class="language-plaintext highlighter-rouge">stackTrace</code> request may contain a <code class="language-plaintext highlighter-rouge">totalFrames</code> property that hints at the total number of frames in the stack. If a client needs this total number upfront, it can issue a request for a single (first) frame and depending on the value of <code class="language-plaintext highlighter-rouge">totalFrames</code> decide how to proceed. In any case a client should be prepared to receive fewer frames than requested, which is an indication that the end of the stack has been reached.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StackTraceRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">stackTrace</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">StackTraceArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">stackTrace</code> request.</p>
<p><a name="Types_StackTraceArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StackTraceArguments</span> <span class="p">{</span>
<span class="cm">/**
* Retrieve the stacktrace for this thread.
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The index of the first frame to return; if omitted frames start at 0.
*/</span>
<span class="nl">startFrame</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The maximum number of frames to return. If levels is not specified or 0,
* all frames are returned.
*/</span>
<span class="nl">levels</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Specifies details on how to format the returned `StackFrame.name`. The
* debug adapter may format requested details in any way that would make sense
* to a developer.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsValueFormattingOptions` is true.
*/</span>
<span class="nl">format</span><span class="p">?:</span> <span class="nx">StackFrameFormat</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">stackTrace</code> request.</p>
<p><a name="Types_StackTraceResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StackTraceResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The frames of the stack frame. If the array has length zero, there are no
* stack frames available.
* This means that there is no location information available.
*/</span>
<span class="na">stackFrames</span><span class="p">:</span> <span class="nx">StackFrame</span><span class="p">[];</span>
<span class="cm">/**
* The total number of frames available in the stack. If omitted or if
* `totalFrames` is larger than the available frames, a client is expected
* to request frames until a request returns less frames than requested
* (which indicates the end of the stack). Returning monotonically
* increasing `totalFrames` values for subsequent requests can be used to
* enforce paging in the client.
*/</span>
<span class="nl">totalFrames</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-scopes-request">
<a name="Requests_Scopes" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Scopes Request</h3>
<p>The request returns the variable scopes for a given stack frame ID.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ScopesRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">scopes</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">ScopesArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">scopes</code> request.</p>
<p><a name="Types_ScopesArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ScopesArguments</span> <span class="p">{</span>
<span class="cm">/**
* Retrieve the scopes for the stack frame identified by `frameId`. The
* `frameId` must have been obtained in the current suspended state. See
* 'Lifetime of Object References' in the Overview section for details.
*/</span>
<span class="nl">frameId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">scopes</code> request.</p>
<p><a name="Types_ScopesResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ScopesResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The scopes of the stack frame. If the array has length zero, there are no
* scopes available.
*/</span>
<span class="na">scopes</span><span class="p">:</span> <span class="nx">Scope</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-variables-request">
<a name="Requests_Variables" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Variables Request</h3>
<p>Retrieves all child variables for the given variable reference.</p>
<p>A filter can be used to limit the fetched children to either named or indexed children.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">VariablesRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">variables</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">VariablesArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">variables</code> request.</p>
<p><a name="Types_VariablesArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">VariablesArguments</span> <span class="p">{</span>
<span class="cm">/**
* The variable for which to retrieve its children. The `variablesReference`
* must have been obtained in the current suspended state. See 'Lifetime of
* Object References' in the Overview section for details.
*/</span>
<span class="nl">variablesReference</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Filter to limit the child variables to either named or indexed. If omitted,
* both types are fetched.
* Values: 'indexed', 'named'
*/</span>
<span class="nl">filter</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">indexed</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">named</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* The index of the first variable to return; if omitted children start at 0.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsVariablePaging` is true.
*/</span>
<span class="nl">start</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of variables to return. If count is missing or 0, all variables
* are returned.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsVariablePaging` is true.
*/</span>
<span class="nl">count</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Specifies details on how to format the Variable values.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsValueFormattingOptions` is true.
*/</span>
<span class="nl">format</span><span class="p">?:</span> <span class="nx">ValueFormat</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">variables</code> request.</p>
<p><a name="Types_VariablesResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">VariablesResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* All (or a range) of variables for the given variable reference.
*/</span>
<span class="na">variables</span><span class="p">:</span> <span class="nx">Variable</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-setvariable-request">
<a name="Requests_SetVariable" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> SetVariable Request</h3>
<p>Set the variable with the given name in the variable container to a new value. Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsSetVariable</code> is true.</p>
<p>If a debug adapter implements both <code class="language-plaintext highlighter-rouge">setVariable</code> and <code class="language-plaintext highlighter-rouge">setExpression</code>, a client will only use <code class="language-plaintext highlighter-rouge">setExpression</code> if the variable has an <code class="language-plaintext highlighter-rouge">evaluateName</code> property.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetVariableRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">setVariable</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">SetVariableArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">setVariable</code> request.</p>
<p><a name="Types_SetVariableArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetVariableArguments</span> <span class="p">{</span>
<span class="cm">/**
* The reference of the variable container. The `variablesReference` must have
* been obtained in the current suspended state. See 'Lifetime of Object
* References' in the Overview section for details.
*/</span>
<span class="nl">variablesReference</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The name of the variable in the container.
*/</span>
<span class="nl">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The value of the variable.
*/</span>
<span class="nl">value</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Specifies details on how to format the response value.
*/</span>
<span class="nl">format</span><span class="p">?:</span> <span class="nx">ValueFormat</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">setVariable</code> request.</p>
<p><a name="Types_SetVariableResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetVariableResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The new value of the variable.
*/</span>
<span class="na">value</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The type of the new value. Typically shown in the UI when hovering over
* the value.
*/</span>
<span class="nl">type</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* If `variablesReference` is > 0, the new value is structured and its
* children can be retrieved by passing `variablesReference` to the
* `variables` request as long as execution remains suspended. See 'Lifetime
* of Object References' in the Overview section for details.
*
* If this property is included in the response, any `variablesReference`
* previously associated with the updated variable, and those of its
* children, are no longer valid.
*/</span>
<span class="nl">variablesReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of named child variables.
* The client can use this information to present the variables in a paged
* UI and fetch them in chunks.
* The value should be less than or equal to 2147483647 (2^31-1).
*/</span>
<span class="nl">namedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of indexed child variables.
* The client can use this information to present the variables in a paged
* UI and fetch them in chunks.
* The value should be less than or equal to 2147483647 (2^31-1).
*/</span>
<span class="nl">indexedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A memory reference to a location appropriate for this result.
* For pointer type eval results, this is generally a reference to the
* memory address contained in the pointer.
* This attribute may be returned by a debug adapter if corresponding
* capability `supportsMemoryReferences` is true.
*/</span>
<span class="nl">memoryReference</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A reference that allows the client to request the location where the new
* value is declared. For example, if the new value is function pointer, the
* adapter may be able to look up the function's location. This should be
* present only if the adapter is likely to be able to resolve the location.
*
* This reference shares the same lifetime as the `variablesReference`. See
* 'Lifetime of Object References' in the Overview section for details.
*/</span>
<span class="nl">valueLocationReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-source-request">
<a name="Requests_Source" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Source Request</h3>
<p>The request retrieves the source code for a given source reference.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SourceRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">source</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">SourceArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">source</code> request.</p>
<p><a name="Types_SourceArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SourceArguments</span> <span class="p">{</span>
<span class="cm">/**
* Specifies the source content to load. Either `source.path` or
* `source.sourceReference` must be specified.
*/</span>
<span class="nl">source</span><span class="p">?:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The reference to the source. This is the same as `source.sourceReference`.
* This is provided for backward compatibility since old clients do not
* understand the `source` attribute.
*/</span>
<span class="nl">sourceReference</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">source</code> request.</p>
<p><a name="Types_SourceResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SourceResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* Content of the source reference.
*/</span>
<span class="na">content</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Content type (MIME type) of the source.
*/</span>
<span class="nl">mimeType</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-threads-request">
<a name="Requests_Threads" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Threads Request</h3>
<p>The request retrieves a list of all threads.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ThreadsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">threads</span><span class="dl">'</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">threads</code> request.</p>
<p><a name="Types_ThreadsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ThreadsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* All threads.
*/</span>
<span class="na">threads</span><span class="p">:</span> <span class="nx">Thread</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-terminatethreads-request">
<a name="Requests_TerminateThreads" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> TerminateThreads Request</h3>
<p>The request terminates the threads with the given ids.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsTerminateThreadsRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">TerminateThreadsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">terminateThreads</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">TerminateThreadsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">terminateThreads</code> request.</p>
<p><a name="Types_TerminateThreadsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">TerminateThreadsArguments</span> <span class="p">{</span>
<span class="cm">/**
* Ids of threads to be terminated.
*/</span>
<span class="nl">threadIds</span><span class="p">?:</span> <span class="kr">number</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">terminateThreads</code> request. This is just an acknowledgement, no body field is required.</p>
<p><a name="Types_TerminateThreadsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">TerminateThreadsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-modules-request">
<a name="Requests_Modules" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Modules Request</h3>
<p>Modules can be retrieved from the debug adapter with this request which can either return all modules or a range of modules to support paging.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsModulesRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ModulesRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">modules</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">ModulesArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">modules</code> request.</p>
<p><a name="Types_ModulesArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ModulesArguments</span> <span class="p">{</span>
<span class="cm">/**
* The index of the first module to return; if omitted modules start at 0.
*/</span>
<span class="nl">startModule</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of modules to return. If `moduleCount` is not specified or 0,
* all modules are returned.
*/</span>
<span class="nl">moduleCount</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">modules</code> request.</p>
<p><a name="Types_ModulesResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ModulesResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* All modules or range of modules.
*/</span>
<span class="na">modules</span><span class="p">:</span> <span class="nx">Module</span><span class="p">[];</span>
<span class="cm">/**
* The total number of modules available.
*/</span>
<span class="nl">totalModules</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-loadedsources-request">
<a name="Requests_LoadedSources" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> LoadedSources Request</h3>
<p>Retrieves the set of all sources currently loaded by the debugged process.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsLoadedSourcesRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LoadedSourcesRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">loadedSources</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">?:</span> <span class="nx">LoadedSourcesArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">loadedSources</code> request.</p>
<p><a name="Types_LoadedSourcesArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LoadedSourcesArguments</span> <span class="p">{</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">loadedSources</code> request.</p>
<p><a name="Types_LoadedSourcesResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LoadedSourcesResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* Set of loaded sources.
*/</span>
<span class="na">sources</span><span class="p">:</span> <span class="nx">Source</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-evaluate-request">
<a name="Requests_Evaluate" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Evaluate Request</h3>
<p>Evaluates the given expression in the context of a stack frame.</p>
<p>The expression has access to any variables and arguments that are in scope.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">EvaluateRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">evaluate</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">EvaluateArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">evaluate</code> request.</p>
<p><a name="Types_EvaluateArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">EvaluateArguments</span> <span class="p">{</span>
<span class="cm">/**
* The expression to evaluate.
*/</span>
<span class="nl">expression</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Evaluate the expression in the scope of this stack frame. If not specified,
* the expression is evaluated in the global scope.
*/</span>
<span class="nl">frameId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The contextual line where the expression should be evaluated. In the
* 'hover' context, this should be set to the start of the expression being
* hovered.
*/</span>
<span class="nl">line</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The contextual column where the expression should be evaluated. This may be
* provided if `line` is also provided.
*
* It is measured in UTF-16 code units and the client capability
* `columnsStartAt1` determines whether it is 0- or 1-based.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The contextual source in which the `line` is found. This must be provided
* if `line` is provided.
*/</span>
<span class="nl">source</span><span class="p">?:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The context in which the evaluate request is used.
* Values:
* 'watch': evaluate is called from a watch view context.
* 'repl': evaluate is called from a REPL context.
* 'hover': evaluate is called to generate the debug hover contents.
* This value should only be used if the corresponding capability
* `supportsEvaluateForHovers` is true.
* 'clipboard': evaluate is called to generate clipboard contents.
* This value should only be used if the corresponding capability
* `supportsClipboardContext` is true.
* 'variables': evaluate is called from a variables view context.
* etc.
*/</span>
<span class="nl">context</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">watch</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">repl</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">hover</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">clipboard</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">variables</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Specifies details on how to format the result.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsValueFormattingOptions` is true.
*/</span>
<span class="nl">format</span><span class="p">?:</span> <span class="nx">ValueFormat</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">evaluate</code> request.</p>
<p><a name="Types_EvaluateResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">EvaluateResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The result of the evaluate request.
*/</span>
<span class="na">result</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The type of the evaluate result.
* This attribute should only be returned by a debug adapter if the
* corresponding capability `supportsVariableType` is true.
*/</span>
<span class="nl">type</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Properties of an evaluate result that can be used to determine how to
* render the result in the UI.
*/</span>
<span class="nl">presentationHint</span><span class="p">?:</span> <span class="nx">VariablePresentationHint</span><span class="p">;</span>
<span class="cm">/**
* If `variablesReference` is > 0, the evaluate result is structured and its
* children can be retrieved by passing `variablesReference` to the
* `variables` request as long as execution remains suspended. See 'Lifetime
* of Object References' in the Overview section for details.
*/</span>
<span class="nl">variablesReference</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of named child variables.
* The client can use this information to present the variables in a paged
* UI and fetch them in chunks.
* The value should be less than or equal to 2147483647 (2^31-1).
*/</span>
<span class="nl">namedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of indexed child variables.
* The client can use this information to present the variables in a paged
* UI and fetch them in chunks.
* The value should be less than or equal to 2147483647 (2^31-1).
*/</span>
<span class="nl">indexedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A memory reference to a location appropriate for this result.
* For pointer type eval results, this is generally a reference to the
* memory address contained in the pointer.
* This attribute may be returned by a debug adapter if corresponding
* capability `supportsMemoryReferences` is true.
*/</span>
<span class="nl">memoryReference</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A reference that allows the client to request the location where the
* returned value is declared. For example, if a function pointer is
* returned, the adapter may be able to look up the function's location.
* This should be present only if the adapter is likely to be able to
* resolve the location.
*
* This reference shares the same lifetime as the `variablesReference`. See
* 'Lifetime of Object References' in the Overview section for details.
*/</span>
<span class="nl">valueLocationReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-setexpression-request">
<a name="Requests_SetExpression" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> SetExpression Request</h3>
<p>Evaluates the given <code class="language-plaintext highlighter-rouge">value</code> expression and assigns it to the <code class="language-plaintext highlighter-rouge">expression</code> which must be a modifiable l-value.</p>
<p>The expressions have access to any variables and arguments that are in scope of the specified frame.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsSetExpression</code> is true.</p>
<p>If a debug adapter implements both <code class="language-plaintext highlighter-rouge">setExpression</code> and <code class="language-plaintext highlighter-rouge">setVariable</code>, a client uses <code class="language-plaintext highlighter-rouge">setExpression</code> if the variable has an <code class="language-plaintext highlighter-rouge">evaluateName</code> property.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetExpressionRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">setExpression</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">SetExpressionArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">setExpression</code> request.</p>
<p><a name="Types_SetExpressionArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetExpressionArguments</span> <span class="p">{</span>
<span class="cm">/**
* The l-value expression to assign to.
*/</span>
<span class="nl">expression</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The value expression to assign to the l-value expression.
*/</span>
<span class="nl">value</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Evaluate the expressions in the scope of this stack frame. If not
* specified, the expressions are evaluated in the global scope.
*/</span>
<span class="nl">frameId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Specifies how the resulting value should be formatted.
*/</span>
<span class="nl">format</span><span class="p">?:</span> <span class="nx">ValueFormat</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">setExpression</code> request.</p>
<p><a name="Types_SetExpressionResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SetExpressionResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The new value of the expression.
*/</span>
<span class="na">value</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The type of the value.
* This attribute should only be returned by a debug adapter if the
* corresponding capability `supportsVariableType` is true.
*/</span>
<span class="nl">type</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Properties of a value that can be used to determine how to render the
* result in the UI.
*/</span>
<span class="nl">presentationHint</span><span class="p">?:</span> <span class="nx">VariablePresentationHint</span><span class="p">;</span>
<span class="cm">/**
* If `variablesReference` is > 0, the evaluate result is structured and its
* children can be retrieved by passing `variablesReference` to the
* `variables` request as long as execution remains suspended. See 'Lifetime
* of Object References' in the Overview section for details.
*/</span>
<span class="nl">variablesReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of named child variables.
* The client can use this information to present the variables in a paged
* UI and fetch them in chunks.
* The value should be less than or equal to 2147483647 (2^31-1).
*/</span>
<span class="nl">namedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of indexed child variables.
* The client can use this information to present the variables in a paged
* UI and fetch them in chunks.
* The value should be less than or equal to 2147483647 (2^31-1).
*/</span>
<span class="nl">indexedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A memory reference to a location appropriate for this result.
* For pointer type eval results, this is generally a reference to the
* memory address contained in the pointer.
* This attribute may be returned by a debug adapter if corresponding
* capability `supportsMemoryReferences` is true.
*/</span>
<span class="nl">memoryReference</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A reference that allows the client to request the location where the new
* value is declared. For example, if the new value is function pointer, the
* adapter may be able to look up the function's location. This should be
* present only if the adapter is likely to be able to resolve the location.
*
* This reference shares the same lifetime as the `variablesReference`. See
* 'Lifetime of Object References' in the Overview section for details.
*/</span>
<span class="nl">valueLocationReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-stepintargets-request">
<a name="Requests_StepInTargets" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> StepInTargets Request</h3>
<p>This request retrieves the possible step-in targets for the specified stack frame.</p>
<p>These targets can be used in the <code class="language-plaintext highlighter-rouge">stepIn</code> request.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsStepInTargetsRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepInTargetsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">stepInTargets</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">StepInTargetsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">stepInTargets</code> request.</p>
<p><a name="Types_StepInTargetsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepInTargetsArguments</span> <span class="p">{</span>
<span class="cm">/**
* The stack frame for which to retrieve the possible step-in targets.
*/</span>
<span class="nl">frameId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">stepInTargets</code> request.</p>
<p><a name="Types_StepInTargetsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepInTargetsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The possible step-in targets of the specified source location.
*/</span>
<span class="na">targets</span><span class="p">:</span> <span class="nx">StepInTarget</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-gototargets-request">
<a name="Requests_GotoTargets" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> GotoTargets Request</h3>
<p>This request retrieves the possible goto targets for the specified source location.</p>
<p>These targets can be used in the <code class="language-plaintext highlighter-rouge">goto</code> request.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsGotoTargetsRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">GotoTargetsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">gotoTargets</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">GotoTargetsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">gotoTargets</code> request.</p>
<p><a name="Types_GotoTargetsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">GotoTargetsArguments</span> <span class="p">{</span>
<span class="cm">/**
* The source location for which the goto targets are determined.
*/</span>
<span class="nl">source</span><span class="p">:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The line location for which the goto targets are determined.
*/</span>
<span class="nl">line</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The position within `line` for which the goto targets are determined. It is
* measured in UTF-16 code units and the client capability `columnsStartAt1`
* determines whether it is 0- or 1-based.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">gotoTargets</code> request.</p>
<p><a name="Types_GotoTargetsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">GotoTargetsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The possible goto targets of the specified location.
*/</span>
<span class="na">targets</span><span class="p">:</span> <span class="nx">GotoTarget</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-completions-request">
<a name="Requests_Completions" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Completions Request</h3>
<p>Returns a list of possible completions for a given caret position and text.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsCompletionsRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">CompletionsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">completions</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">CompletionsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">completions</code> request.</p>
<p><a name="Types_CompletionsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">CompletionsArguments</span> <span class="p">{</span>
<span class="cm">/**
* Returns completions in the scope of this stack frame. If not specified, the
* completions are returned for the global scope.
*/</span>
<span class="nl">frameId</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* One or more source lines. Typically this is the text users have typed into
* the debug console before they asked for completion.
*/</span>
<span class="nl">text</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The position within `text` for which to determine the completion proposals.
* It is measured in UTF-16 code units and the client capability
* `columnsStartAt1` determines whether it is 0- or 1-based.
*/</span>
<span class="nl">column</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A line for which to determine the completion proposals. If missing the
* first line of the text is assumed.
*/</span>
<span class="nl">line</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">completions</code> request.</p>
<p><a name="Types_CompletionsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">CompletionsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* The possible completions for .
*/</span>
<span class="na">targets</span><span class="p">:</span> <span class="nx">CompletionItem</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-exceptioninfo-request">
<a name="Requests_ExceptionInfo" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> ExceptionInfo Request</h3>
<p>Retrieves the details of the exception that caused this event to be raised.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsExceptionInfoRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ExceptionInfoRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">exceptionInfo</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">ExceptionInfoArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">exceptionInfo</code> request.</p>
<p><a name="Types_ExceptionInfoArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ExceptionInfoArguments</span> <span class="p">{</span>
<span class="cm">/**
* Thread for which exception information should be retrieved.
*/</span>
<span class="nl">threadId</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">exceptionInfo</code> request.</p>
<p><a name="Types_ExceptionInfoResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ExceptionInfoResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">:</span> <span class="p">{</span>
<span class="cm">/**
* ID of the exception that was thrown.
*/</span>
<span class="na">exceptionId</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Descriptive text for the exception.
*/</span>
<span class="nl">description</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Mode that caused the exception notification to be raised.
*/</span>
<span class="nl">breakMode</span><span class="p">:</span> <span class="nx">ExceptionBreakMode</span><span class="p">;</span>
<span class="cm">/**
* Detailed information about the exception.
*/</span>
<span class="nl">details</span><span class="p">?:</span> <span class="nx">ExceptionDetails</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-readmemory-request">
<a name="Requests_ReadMemory" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> ReadMemory Request</h3>
<p>Reads bytes from memory at the provided location.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsReadMemoryRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ReadMemoryRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">readMemory</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">ReadMemoryArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">readMemory</code> request.</p>
<p><a name="Types_ReadMemoryArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ReadMemoryArguments</span> <span class="p">{</span>
<span class="cm">/**
* Memory reference to the base location from which data should be read.
*/</span>
<span class="nl">memoryReference</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Offset (in bytes) to be applied to the reference location before reading
* data. Can be negative.
*/</span>
<span class="nl">offset</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Number of bytes to read at the specified location and offset.
*/</span>
<span class="nl">count</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">readMemory</code> request.</p>
<p><a name="Types_ReadMemoryResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ReadMemoryResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">?:</span> <span class="p">{</span>
<span class="cm">/**
* The address of the first byte of data returned.
* Treated as a hex value if prefixed with `0x`, or as a decimal value
* otherwise.
*/</span>
<span class="na">address</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The number of unreadable bytes encountered after the last successfully
* read byte.
* This can be used to determine the number of bytes that should be skipped
* before a subsequent `readMemory` request succeeds.
*/</span>
<span class="nl">unreadableBytes</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The bytes read from memory, encoded using base64. If the decoded length
* of `data` is less than the requested `count` in the original `readMemory`
* request, and `unreadableBytes` is zero or omitted, then the client should
* assume it's reached the end of readable memory.
*/</span>
<span class="nl">data</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-writememory-request">
<a name="Requests_WriteMemory" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> WriteMemory Request</h3>
<p>Writes bytes to memory at the provided location.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsWriteMemoryRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">WriteMemoryRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">writeMemory</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">WriteMemoryArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">writeMemory</code> request.</p>
<p><a name="Types_WriteMemoryArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">WriteMemoryArguments</span> <span class="p">{</span>
<span class="cm">/**
* Memory reference to the base location to which data should be written.
*/</span>
<span class="nl">memoryReference</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Offset (in bytes) to be applied to the reference location before writing
* data. Can be negative.
*/</span>
<span class="nl">offset</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Property to control partial writes. If true, the debug adapter should
* attempt to write memory even if the entire memory region is not writable.
* In such a case the debug adapter should stop after hitting the first byte
* of memory that cannot be written and return the number of bytes written in
* the response via the `offset` and `bytesWritten` properties.
* If false or missing, a debug adapter should attempt to verify the region is
* writable before writing, and fail the response if it is not.
*/</span>
<span class="nl">allowPartial</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Bytes to write, encoded using base64.
*/</span>
<span class="nl">data</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">writeMemory</code> request.</p>
<p><a name="Types_WriteMemoryResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">WriteMemoryResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">?:</span> <span class="p">{</span>
<span class="cm">/**
* Property that should be returned when `allowPartial` is true to indicate
* the offset of the first byte of data successfully written. Can be
* negative.
*/</span>
<span class="nx">offset</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Property that should be returned when `allowPartial` is true to indicate
* the number of bytes starting from address that were successfully written.
*/</span>
<span class="nl">bytesWritten</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-disassemble-request">
<a name="Requests_Disassemble" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Disassemble Request</h3>
<p>Disassembles code stored at the provided location.</p>
<p>Clients should only call this request if the corresponding capability <code class="language-plaintext highlighter-rouge">supportsDisassembleRequest</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DisassembleRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">disassemble</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">DisassembleArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">disassemble</code> request.</p>
<p><a name="Types_DisassembleArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DisassembleArguments</span> <span class="p">{</span>
<span class="cm">/**
* Memory reference to the base location containing the instructions to
* disassemble.
*/</span>
<span class="nl">memoryReference</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Offset (in bytes) to be applied to the reference location before
* disassembling. Can be negative.
*/</span>
<span class="nl">offset</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Offset (in instructions) to be applied after the byte offset (if any)
* before disassembling. Can be negative.
*/</span>
<span class="nl">instructionOffset</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Number of instructions to disassemble starting at the specified location
* and offset.
* An adapter must return exactly this number of instructions - any
* unavailable instructions should be replaced with an implementation-defined
* 'invalid instruction' value.
*/</span>
<span class="nl">instructionCount</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If true, the adapter should attempt to resolve memory addresses and other
* values to symbolic names.
*/</span>
<span class="nl">resolveSymbols</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">disassemble</code> request.</p>
<p><a name="Types_DisassembleResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DisassembleResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">?:</span> <span class="p">{</span>
<span class="cm">/**
* The list of disassembled instructions.
*/</span>
<span class="na">instructions</span><span class="p">:</span> <span class="nx">DisassembledInstruction</span><span class="p">[];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="leftwards_arrow_with_hook-locations-request">
<a name="Requests_Locations" class="anchor"></a><img class="emoji" title=":leftwards_arrow_with_hook:" alt=":leftwards_arrow_with_hook:" src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png" height="20" width="20"> Locations Request</h3>
<p>Looks up information about a location reference previously returned by the debug adapter.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LocationsRequest</span> <span class="kd">extends</span> <span class="nx">Request</span> <span class="p">{</span>
<span class="nl">command</span><span class="p">:</span> <span class="dl">'</span><span class="s1">locations</span><span class="dl">'</span><span class="p">;</span>
<span class="nl">arguments</span><span class="p">:</span> <span class="nx">LocationsArguments</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Arguments for <code class="language-plaintext highlighter-rouge">locations</code> request.</p>
<p><a name="Types_LocationsArguments" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LocationsArguments</span> <span class="p">{</span>
<span class="cm">/**
* Location reference to resolve.
*/</span>
<span class="nl">locationReference</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<p>Response to <code class="language-plaintext highlighter-rouge">locations</code> request.</p>
<p><a name="Types_LocationsResponse" class="anchor"></a></p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">LocationsResponse</span> <span class="kd">extends</span> <span class="nx">Response</span> <span class="p">{</span>
<span class="nl">body</span><span class="p">?:</span> <span class="p">{</span>
<span class="cm">/**
* The source containing the location; either `source.path` or
* `source.sourceReference` must be specified.
*/</span>
<span class="na">source</span><span class="p">:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The line number of the location. The client capability `linesStartAt1`
* determines whether it is 0- or 1-based.
*/</span>
<span class="nl">line</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Position of the location within the `line`. It is measured in UTF-16 code
* units and the client capability `columnsStartAt1` determines whether it
* is 0- or 1-based. If no column is given, the first position in the start
* line is assumed.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* End line of the location, present if the location refers to a range. The
* client capability `linesStartAt1` determines whether it is 0- or 1-based.
*/</span>
<span class="nl">endLine</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* End position of the location within `endLine`, present if the location
* refers to a range. It is measured in UTF-16 code units and the client
* capability `columnsStartAt1` determines whether it is 0- or 1-based.
*/</span>
<span class="nl">endColumn</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div></div>
<h2 id="types">
<a name="Types" class="anchor"></a>Types</h2>
<h3 id="capabilities">
<a name="Types_Capabilities" class="anchor"></a>Capabilities</h3>
<p>Information about the capabilities of a debug adapter.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Capabilities</span> <span class="p">{</span>
<span class="cm">/**
* The debug adapter supports the `configurationDone` request.
*/</span>
<span class="nl">supportsConfigurationDoneRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports function breakpoints.
*/</span>
<span class="nl">supportsFunctionBreakpoints</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports conditional breakpoints.
*/</span>
<span class="nl">supportsConditionalBreakpoints</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports breakpoints that break execution after a
* specified number of hits.
*/</span>
<span class="nl">supportsHitConditionalBreakpoints</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports a (side effect free) `evaluate` request for data
* hovers.
*/</span>
<span class="nl">supportsEvaluateForHovers</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Available exception filter options for the `setExceptionBreakpoints`
* request.
*/</span>
<span class="nl">exceptionBreakpointFilters</span><span class="p">?:</span> <span class="nx">ExceptionBreakpointsFilter</span><span class="p">[];</span>
<span class="cm">/**
* The debug adapter supports stepping back via the `stepBack` and
* `reverseContinue` requests.
*/</span>
<span class="nl">supportsStepBack</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports setting a variable to a value.
*/</span>
<span class="nl">supportsSetVariable</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports restarting a frame.
*/</span>
<span class="nl">supportsRestartFrame</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `gotoTargets` request.
*/</span>
<span class="nl">supportsGotoTargetsRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `stepInTargets` request.
*/</span>
<span class="nl">supportsStepInTargetsRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `completions` request.
*/</span>
<span class="nl">supportsCompletionsRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The set of characters that should trigger completion in a REPL. If not
* specified, the UI should assume the `.` character.
*/</span>
<span class="nl">completionTriggerCharacters</span><span class="p">?:</span> <span class="kr">string</span><span class="p">[];</span>
<span class="cm">/**
* The debug adapter supports the `modules` request.
*/</span>
<span class="nl">supportsModulesRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The set of additional module information exposed by the debug adapter.
*/</span>
<span class="nl">additionalModuleColumns</span><span class="p">?:</span> <span class="nx">ColumnDescriptor</span><span class="p">[];</span>
<span class="cm">/**
* Checksum algorithms supported by the debug adapter.
*/</span>
<span class="nl">supportedChecksumAlgorithms</span><span class="p">?:</span> <span class="nx">ChecksumAlgorithm</span><span class="p">[];</span>
<span class="cm">/**
* The debug adapter supports the `restart` request. In this case a client
* should not implement `restart` by terminating and relaunching the adapter
* but by calling the `restart` request.
*/</span>
<span class="nl">supportsRestartRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports `exceptionOptions` on the
* `setExceptionBreakpoints` request.
*/</span>
<span class="nl">supportsExceptionOptions</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports a `format` attribute on the `stackTrace`,
* `variables`, and `evaluate` requests.
*/</span>
<span class="nl">supportsValueFormattingOptions</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `exceptionInfo` request.
*/</span>
<span class="nl">supportsExceptionInfoRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `terminateDebuggee` attribute on the
* `disconnect` request.
*/</span>
<span class="nl">supportTerminateDebuggee</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `suspendDebuggee` attribute on the
* `disconnect` request.
*/</span>
<span class="nl">supportSuspendDebuggee</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the delayed loading of parts of the stack, which
* requires that both the `startFrame` and `levels` arguments and the
* `totalFrames` result of the `stackTrace` request are supported.
*/</span>
<span class="nl">supportsDelayedStackTraceLoading</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `loadedSources` request.
*/</span>
<span class="nl">supportsLoadedSourcesRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports log points by interpreting the `logMessage`
* attribute of the `SourceBreakpoint`.
*/</span>
<span class="nl">supportsLogPoints</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `terminateThreads` request.
*/</span>
<span class="nl">supportsTerminateThreadsRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `setExpression` request.
*/</span>
<span class="nl">supportsSetExpression</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `terminate` request.
*/</span>
<span class="nl">supportsTerminateRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports data breakpoints.
*/</span>
<span class="nl">supportsDataBreakpoints</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `readMemory` request.
*/</span>
<span class="nl">supportsReadMemoryRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `writeMemory` request.
*/</span>
<span class="nl">supportsWriteMemoryRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `disassemble` request.
*/</span>
<span class="nl">supportsDisassembleRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `cancel` request.
*/</span>
<span class="nl">supportsCancelRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `breakpointLocations` request.
*/</span>
<span class="nl">supportsBreakpointLocationsRequest</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `clipboard` context value in the `evaluate`
* request.
*/</span>
<span class="nl">supportsClipboardContext</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports stepping granularities (argument `granularity`)
* for the stepping requests.
*/</span>
<span class="nl">supportsSteppingGranularity</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports adding breakpoints based on instruction
* references.
*/</span>
<span class="nl">supportsInstructionBreakpoints</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports `filterOptions` as an argument on the
* `setExceptionBreakpoints` request.
*/</span>
<span class="nl">supportsExceptionFilterOptions</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `singleThread` property on the execution
* requests (`continue`, `next`, `stepIn`, `stepOut`, `reverseContinue`,
* `stepBack`).
*/</span>
<span class="nl">supportsSingleThreadExecutionRequests</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The debug adapter supports the `asAddress` and `bytes` fields in the
* `dataBreakpointInfo` request.
*/</span>
<span class="nl">supportsDataBreakpointBytes</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Modes of breakpoints supported by the debug adapter, such as 'hardware' or
* 'software'. If present, the client may allow the user to select a mode and
* include it in its `setBreakpoints` request.
*
* Clients may present the first applicable mode in this array as the
* 'default' mode in gestures that set breakpoints.
*/</span>
<span class="nl">breakpointModes</span><span class="p">?:</span> <span class="nx">BreakpointMode</span><span class="p">[];</span>
<span class="cm">/**
* The debug adapter supports ANSI escape sequences in styling of
* `OutputEvent.output` and `Variable.value` fields.
*/</span>
<span class="nl">supportsANSIStyling</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="exceptionbreakpointsfilter">
<a name="Types_ExceptionBreakpointsFilter" class="anchor"></a>ExceptionBreakpointsFilter</h3>
<p>An <code class="language-plaintext highlighter-rouge">ExceptionBreakpointsFilter</code> is shown in the UI as an filter option for configuring how exceptions are dealt with.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ExceptionBreakpointsFilter</span> <span class="p">{</span>
<span class="cm">/**
* The internal ID of the filter option. This value is passed to the
* `setExceptionBreakpoints` request.
*/</span>
<span class="nl">filter</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The name of the filter option. This is shown in the UI.
*/</span>
<span class="nl">label</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A help text providing additional information about the exception filter.
* This string is typically shown as a hover and can be translated.
*/</span>
<span class="nl">description</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Initial value of the filter option. If not specified a value false is
* assumed.
*/</span>
<span class="nl">default</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Controls whether a condition can be specified for this filter option. If
* false or missing, a condition can not be set.
*/</span>
<span class="nl">supportsCondition</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* A help text providing information about the condition. This string is shown
* as the placeholder text for a text box and can be translated.
*/</span>
<span class="nl">conditionDescription</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="message">
<a name="Types_Message" class="anchor"></a>Message</h3>
<p>A structured message object. Used to return errors from requests.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Message</span> <span class="p">{</span>
<span class="cm">/**
* Unique (within a debug adapter implementation) identifier for the message.
* The purpose of these error IDs is to help extension authors that have the
* requirement that every user visible error message needs a corresponding
* error number, so that users or customer support can find information about
* the specific error more easily.
*/</span>
<span class="nl">id</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A format string for the message. Embedded variables have the form `{name}`.
* If variable name starts with an underscore character, the variable does not
* contain user data (PII) and can be safely used for telemetry purposes.
*/</span>
<span class="nl">format</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* An object used as a dictionary for looking up the variables in the format
* string.
*/</span>
<span class="nl">variables</span><span class="p">?:</span> <span class="p">{</span> <span class="p">[</span><span class="na">key</span><span class="p">:</span> <span class="kr">string</span><span class="p">]:</span> <span class="kr">string</span><span class="p">;</span> <span class="p">};</span>
<span class="cm">/**
* If true send to telemetry.
*/</span>
<span class="nl">sendTelemetry</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* If true show user.
*/</span>
<span class="nl">showUser</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* A url where additional information about this message can be found.
*/</span>
<span class="nl">url</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A label that is presented to the user as the UI for opening the url.
*/</span>
<span class="nl">urlLabel</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="module">
<a name="Types_Module" class="anchor"></a>Module</h3>
<p>A Module object represents a row in the modules view.</p>
<p>The <code class="language-plaintext highlighter-rouge">id</code> attribute identifies a module in the modules view and is used in a <code class="language-plaintext highlighter-rouge">module</code> event for identifying a module for adding, updating or deleting.</p>
<p>The <code class="language-plaintext highlighter-rouge">name</code> attribute is used to minimally render the module in the UI.</p>
<p>Additional attributes can be added to the module. They show up in the module view if they have a corresponding <code class="language-plaintext highlighter-rouge">ColumnDescriptor</code>.</p>
<p>To avoid an unnecessary proliferation of additional attributes with similar semantics but different names, we recommend to re-use attributes from the ‘recommended’ list below first, and only introduce new attributes if nothing appropriate could be found.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Module</span> <span class="p">{</span>
<span class="cm">/**
* Unique identifier for the module.
*/</span>
<span class="nl">id</span><span class="p">:</span> <span class="kr">number</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A name of the module.
*/</span>
<span class="nl">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Logical full path to the module. The exact definition is implementation
* defined, but usually this would be a full path to the on-disk file for the
* module.
*/</span>
<span class="nl">path</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* True if the module is optimized.
*/</span>
<span class="nl">isOptimized</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* True if the module is considered 'user code' by a debugger that supports
* 'Just My Code'.
*/</span>
<span class="nl">isUserCode</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Version of Module.
*/</span>
<span class="nl">version</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* User-understandable description of if symbols were found for the module
* (ex: 'Symbols Loaded', 'Symbols not found', etc.)
*/</span>
<span class="nl">symbolStatus</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Logical full path to the symbol file. The exact definition is
* implementation defined.
*/</span>
<span class="nl">symbolFilePath</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Module created or modified, encoded as a RFC 3339 timestamp.
*/</span>
<span class="nl">dateTimeStamp</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Address range covered by this module.
*/</span>
<span class="nl">addressRange</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="columndescriptor">
<a name="Types_ColumnDescriptor" class="anchor"></a>ColumnDescriptor</h3>
<p>A <code class="language-plaintext highlighter-rouge">ColumnDescriptor</code> specifies what module attribute to show in a column of the modules view, how to format it,</p>
<p>and what the column’s label should be.</p>
<p>It is only used if the underlying UI actually supports this level of customization.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ColumnDescriptor</span> <span class="p">{</span>
<span class="cm">/**
* Name of the attribute rendered in this column.
*/</span>
<span class="nl">attributeName</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Header UI label of column.
*/</span>
<span class="nl">label</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Format to use for the rendered values in this column. TBD how the format
* strings looks like.
*/</span>
<span class="nl">format</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Datatype of values in this column. Defaults to `string` if not specified.
* Values: 'string', 'number', 'boolean', 'unixTimestampUTC'
*/</span>
<span class="nl">type</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">string</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">number</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">boolean</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">unixTimestampUTC</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* Width of this column in characters (hint only).
*/</span>
<span class="nl">width</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="thread">
<a name="Types_Thread" class="anchor"></a>Thread</h3>
<p>A Thread</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Thread</span> <span class="p">{</span>
<span class="cm">/**
* Unique identifier for the thread.
*/</span>
<span class="nl">id</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The name of the thread.
*/</span>
<span class="nl">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="source">
<a name="Types_Source" class="anchor"></a>Source</h3>
<p>A <code class="language-plaintext highlighter-rouge">Source</code> is a descriptor for source code.</p>
<p>It is returned from the debug adapter as part of a <code class="language-plaintext highlighter-rouge">StackFrame</code> and it is used by clients when specifying breakpoints.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Source</span> <span class="p">{</span>
<span class="cm">/**
* The short name of the source. Every source returned from the debug adapter
* has a name.
* When sending a source to the debug adapter this name is optional.
*/</span>
<span class="nl">name</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The path of the source to be shown in the UI.
* It is only used to locate and load the content of the source if no
* `sourceReference` is specified (or its value is 0).
*/</span>
<span class="nl">path</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* If the value > 0 the contents of the source must be retrieved through the
* `source` request (even if a path is specified).
* Since a `sourceReference` is only valid for a session, it can not be used
* to persist a source.
* The value should be less than or equal to 2147483647 (2^31-1).
*/</span>
<span class="nl">sourceReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A hint for how to present the source in the UI.
* A value of `deemphasize` can be used to indicate that the source is not
* available or that it is skipped on stepping.
* Values: 'normal', 'emphasize', 'deemphasize'
*/</span>
<span class="nl">presentationHint</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">normal</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">emphasize</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">deemphasize</span><span class="dl">'</span><span class="p">;</span>
<span class="cm">/**
* The origin of this source. For example, 'internal module', 'inlined content
* from source map', etc.
*/</span>
<span class="nl">origin</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A list of sources that are related to this source. These may be the source
* that generated this source.
*/</span>
<span class="nl">sources</span><span class="p">?:</span> <span class="nx">Source</span><span class="p">[];</span>
<span class="cm">/**
* Additional data that a debug adapter might want to loop through the client.
* The client should leave the data intact and persist it across sessions. The
* client should not interpret the data.
*/</span>
<span class="nl">adapterData</span><span class="p">?:</span> <span class="kr">any</span><span class="p">;</span>
<span class="cm">/**
* The checksums associated with this file.
*/</span>
<span class="nl">checksums</span><span class="p">?:</span> <span class="nx">Checksum</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="stackframe">
<a name="Types_StackFrame" class="anchor"></a>StackFrame</h3>
<p>A Stackframe contains the source location.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StackFrame</span> <span class="p">{</span>
<span class="cm">/**
* An identifier for the stack frame. It must be unique across all threads.
* This id can be used to retrieve the scopes of the frame with the `scopes`
* request or to restart the execution of a stack frame.
*/</span>
<span class="nl">id</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The name of the stack frame, typically a method name.
*/</span>
<span class="nl">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The source of the frame.
*/</span>
<span class="nl">source</span><span class="p">?:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The line within the source of the frame. If the source attribute is missing
* or doesn't exist, `line` is 0 and should be ignored by the client.
*/</span>
<span class="nl">line</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Start position of the range covered by the stack frame. It is measured in
* UTF-16 code units and the client capability `columnsStartAt1` determines
* whether it is 0- or 1-based. If attribute `source` is missing or doesn't
* exist, `column` is 0 and should be ignored by the client.
*/</span>
<span class="nl">column</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end line of the range covered by the stack frame.
*/</span>
<span class="nl">endLine</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* End position of the range covered by the stack frame. It is measured in
* UTF-16 code units and the client capability `columnsStartAt1` determines
* whether it is 0- or 1-based.
*/</span>
<span class="nl">endColumn</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Indicates whether this frame can be restarted with the `restartFrame`
* request. Clients should only use this if the debug adapter supports the
* `restart` request and the corresponding capability `supportsRestartFrame`
* is true. If a debug adapter has this capability, then `canRestart` defaults
* to `true` if the property is absent.
*/</span>
<span class="nl">canRestart</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* A memory reference for the current instruction pointer in this frame.
*/</span>
<span class="nl">instructionPointerReference</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The module associated with this frame, if any.
*/</span>
<span class="nl">moduleId</span><span class="p">?:</span> <span class="kr">number</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A hint for how to present this frame in the UI.
* A value of `label` can be used to indicate that the frame is an artificial
* frame that is used as a visual label or separator. A value of `subtle` can
* be used to change the appearance of a frame in a 'subtle' way.
* Values: 'normal', 'label', 'subtle'
*/</span>
<span class="nl">presentationHint</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">normal</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">label</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">subtle</span><span class="dl">'</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="scope">
<a name="Types_Scope" class="anchor"></a>Scope</h3>
<p>A <code class="language-plaintext highlighter-rouge">Scope</code> is a named container for variables. Optionally a scope can map to a source or a range within a source.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Scope</span> <span class="p">{</span>
<span class="cm">/**
* Name of the scope such as 'Arguments', 'Locals', or 'Registers'. This
* string is shown in the UI as is and can be translated.
*/</span>
<span class="nl">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A hint for how to present this scope in the UI. If this attribute is
* missing, the scope is shown with a generic UI.
* Values:
* 'arguments': Scope contains method arguments.
* 'locals': Scope contains local variables.
* 'registers': Scope contains registers. Only a single `registers` scope
* should be returned from a `scopes` request.
* 'returnValue': Scope contains one or more return values.
* etc.
*/</span>
<span class="nl">presentationHint</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">arguments</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">locals</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">registers</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">returnValue</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The variables of this scope can be retrieved by passing the value of
* `variablesReference` to the `variables` request as long as execution
* remains suspended. See 'Lifetime of Object References' in the Overview
* section for details.
*/</span>
<span class="nl">variablesReference</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of named variables in this scope.
* The client can use this information to present the variables in a paged UI
* and fetch them in chunks.
*/</span>
<span class="nl">namedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of indexed variables in this scope.
* The client can use this information to present the variables in a paged UI
* and fetch them in chunks.
*/</span>
<span class="nl">indexedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If true, the number of variables in this scope is large or expensive to
* retrieve.
*/</span>
<span class="nl">expensive</span><span class="p">:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* The source for this scope.
*/</span>
<span class="nl">source</span><span class="p">?:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The start line of the range covered by this scope.
*/</span>
<span class="nl">line</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Start position of the range covered by the scope. It is measured in UTF-16
* code units and the client capability `columnsStartAt1` determines whether
* it is 0- or 1-based.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end line of the range covered by this scope.
*/</span>
<span class="nl">endLine</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* End position of the range covered by the scope. It is measured in UTF-16
* code units and the client capability `columnsStartAt1` determines whether
* it is 0- or 1-based.
*/</span>
<span class="nl">endColumn</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="variable">
<a name="Types_Variable" class="anchor"></a>Variable</h3>
<p>A Variable is a name/value pair.</p>
<p>The <code class="language-plaintext highlighter-rouge">type</code> attribute is shown if space permits or when hovering over the variable’s name.</p>
<p>The <code class="language-plaintext highlighter-rouge">kind</code> attribute is used to render additional properties of the variable, e.g. different icons can be used to indicate that a variable is public or private.</p>
<p>If the value is structured (has children), a handle is provided to retrieve the children with the <code class="language-plaintext highlighter-rouge">variables</code> request.</p>
<p>If the number of named or indexed children is large, the numbers should be returned via the <code class="language-plaintext highlighter-rouge">namedVariables</code> and <code class="language-plaintext highlighter-rouge">indexedVariables</code> attributes.</p>
<p>The client can use this information to present the children in a paged UI and fetch them in chunks.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Variable</span> <span class="p">{</span>
<span class="cm">/**
* The variable's name.
*/</span>
<span class="nl">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The variable's value.
* This can be a multi-line text, e.g. for a function the body of a function.
* For structured variables (which do not have a simple value), it is
* recommended to provide a one-line representation of the structured object.
* This helps to identify the structured object in the collapsed state when
* its children are not yet visible.
* An empty string can be used if no value should be shown in the UI.
*/</span>
<span class="nl">value</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The type of the variable's value. Typically shown in the UI when hovering
* over the value.
* This attribute should only be returned by a debug adapter if the
* corresponding capability `supportsVariableType` is true.
*/</span>
<span class="nl">type</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Properties of a variable that can be used to determine how to render the
* variable in the UI.
*/</span>
<span class="nl">presentationHint</span><span class="p">?:</span> <span class="nx">VariablePresentationHint</span><span class="p">;</span>
<span class="cm">/**
* The evaluatable name of this variable which can be passed to the `evaluate`
* request to fetch the variable's value.
*/</span>
<span class="nl">evaluateName</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* If `variablesReference` is > 0, the variable is structured and its children
* can be retrieved by passing `variablesReference` to the `variables` request
* as long as execution remains suspended. See 'Lifetime of Object References'
* in the Overview section for details.
*/</span>
<span class="nl">variablesReference</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of named child variables.
* The client can use this information to present the children in a paged UI
* and fetch them in chunks.
*/</span>
<span class="nl">namedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The number of indexed child variables.
* The client can use this information to present the children in a paged UI
* and fetch them in chunks.
*/</span>
<span class="nl">indexedVariables</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A memory reference associated with this variable.
* For pointer type variables, this is generally a reference to the memory
* address contained in the pointer.
* For executable data, this reference may later be used in a `disassemble`
* request.
* This attribute may be returned by a debug adapter if corresponding
* capability `supportsMemoryReferences` is true.
*/</span>
<span class="nl">memoryReference</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A reference that allows the client to request the location where the
* variable is declared. This should be present only if the adapter is likely
* to be able to resolve the location.
*
* This reference shares the same lifetime as the `variablesReference`. See
* 'Lifetime of Object References' in the Overview section for details.
*/</span>
<span class="nl">declarationLocationReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A reference that allows the client to request the location where the
* variable's value is declared. For example, if the variable contains a
* function pointer, the adapter may be able to look up the function's
* location. This should be present only if the adapter is likely to be able
* to resolve the location.
*
* This reference shares the same lifetime as the `variablesReference`. See
* 'Lifetime of Object References' in the Overview section for details.
*/</span>
<span class="nl">valueLocationReference</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="variablepresentationhint">
<a name="Types_VariablePresentationHint" class="anchor"></a>VariablePresentationHint</h3>
<p>Properties of a variable that can be used to determine how to render the variable in the UI.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">VariablePresentationHint</span> <span class="p">{</span>
<span class="cm">/**
* The kind of variable. Before introducing additional values, try to use the
* listed values.
* Values:
* 'property': Indicates that the object is a property.
* 'method': Indicates that the object is a method.
* 'class': Indicates that the object is a class.
* 'data': Indicates that the object is data.
* 'event': Indicates that the object is an event.
* 'baseClass': Indicates that the object is a base class.
* 'innerClass': Indicates that the object is an inner class.
* 'interface': Indicates that the object is an interface.
* 'mostDerivedClass': Indicates that the object is the most derived class.
* 'virtual': Indicates that the object is virtual, that means it is a
* synthetic object introduced by the adapter for rendering purposes, e.g. an
* index range for large arrays.
* 'dataBreakpoint': Deprecated: Indicates that a data breakpoint is
* registered for the object. The `hasDataBreakpoint` attribute should
* generally be used instead.
* etc.
*/</span>
<span class="nl">kind</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">property</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">method</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">class</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">data</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">event</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">baseClass</span><span class="dl">'</span>
<span class="o">|</span> <span class="dl">'</span><span class="s1">innerClass</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">interface</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">mostDerivedClass</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">virtual</span><span class="dl">'</span>
<span class="o">|</span> <span class="dl">'</span><span class="s1">dataBreakpoint</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Set of attributes represented as an array of strings. Before introducing
* additional values, try to use the listed values.
* Values:
* 'static': Indicates that the object is static.
* 'constant': Indicates that the object is a constant.
* 'readOnly': Indicates that the object is read only.
* 'rawString': Indicates that the object is a raw string.
* 'hasObjectId': Indicates that the object can have an Object ID created for
* it. This is a vestigial attribute that is used by some clients; 'Object
* ID's are not specified in the protocol.
* 'canHaveObjectId': Indicates that the object has an Object ID associated
* with it. This is a vestigial attribute that is used by some clients;
* 'Object ID's are not specified in the protocol.
* 'hasSideEffects': Indicates that the evaluation had side effects.
* 'hasDataBreakpoint': Indicates that the object has its value tracked by a
* data breakpoint.
* etc.
*/</span>
<span class="nl">attributes</span><span class="p">?:</span> <span class="p">(</span><span class="dl">'</span><span class="s1">static</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">constant</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">readOnly</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">rawString</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">hasObjectId</span><span class="dl">'</span>
<span class="o">|</span> <span class="dl">'</span><span class="s1">canHaveObjectId</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">hasSideEffects</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">hasDataBreakpoint</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">)[];</span>
<span class="cm">/**
* Visibility of variable. Before introducing additional values, try to use
* the listed values.
* Values: 'public', 'private', 'protected', 'internal', 'final', etc.
*/</span>
<span class="nl">visibility</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">public</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">private</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">protected</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">internal</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">final</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* If true, clients can present the variable with a UI that supports a
* specific gesture to trigger its evaluation.
* This mechanism can be used for properties that require executing code when
* retrieving their value and where the code execution can be expensive and/or
* produce side-effects. A typical example are properties based on a getter
* function.
* Please note that in addition to the `lazy` flag, the variable's
* `variablesReference` is expected to refer to a variable that will provide
* the value through another `variable` request.
*/</span>
<span class="nl">lazy</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="breakpointlocation">
<a name="Types_BreakpointLocation" class="anchor"></a>BreakpointLocation</h3>
<p>Properties of a breakpoint location returned from the <code class="language-plaintext highlighter-rouge">breakpointLocations</code> request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">BreakpointLocation</span> <span class="p">{</span>
<span class="cm">/**
* Start line of breakpoint location.
*/</span>
<span class="nl">line</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The start position of a breakpoint location. Position is measured in UTF-16
* code units and the client capability `columnsStartAt1` determines whether
* it is 0- or 1-based.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end line of breakpoint location if the location covers a range.
*/</span>
<span class="nl">endLine</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end position of a breakpoint location (if the location covers a range).
* Position is measured in UTF-16 code units and the client capability
* `columnsStartAt1` determines whether it is 0- or 1-based.
*/</span>
<span class="nl">endColumn</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="sourcebreakpoint">
<a name="Types_SourceBreakpoint" class="anchor"></a>SourceBreakpoint</h3>
<p>Properties of a breakpoint or logpoint passed to the <code class="language-plaintext highlighter-rouge">setBreakpoints</code> request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">SourceBreakpoint</span> <span class="p">{</span>
<span class="cm">/**
* The source line of the breakpoint or logpoint.
*/</span>
<span class="nl">line</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Start position within source line of the breakpoint or logpoint. It is
* measured in UTF-16 code units and the client capability `columnsStartAt1`
* determines whether it is 0- or 1-based.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The expression for conditional breakpoints.
* It is only honored by a debug adapter if the corresponding capability
* `supportsConditionalBreakpoints` is true.
*/</span>
<span class="nl">condition</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The expression that controls how many hits of the breakpoint are ignored.
* The debug adapter is expected to interpret the expression as needed.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsHitConditionalBreakpoints` is true.
* If both this property and `condition` are specified, `hitCondition` should
* be evaluated only if the `condition` is met, and the debug adapter should
* stop only if both conditions are met.
*/</span>
<span class="nl">hitCondition</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* If this attribute exists and is non-empty, the debug adapter must not
* 'break' (stop)
* but log the message instead. Expressions within `{}` are interpolated.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsLogPoints` is true.
* If either `hitCondition` or `condition` is specified, then the message
* should only be logged if those conditions are met.
*/</span>
<span class="nl">logMessage</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The mode of this breakpoint. If defined, this must be one of the
* `breakpointModes` the debug adapter advertised in its `Capabilities`.
*/</span>
<span class="nl">mode</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="functionbreakpoint">
<a name="Types_FunctionBreakpoint" class="anchor"></a>FunctionBreakpoint</h3>
<p>Properties of a breakpoint passed to the <code class="language-plaintext highlighter-rouge">setFunctionBreakpoints</code> request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">FunctionBreakpoint</span> <span class="p">{</span>
<span class="cm">/**
* The name of the function.
*/</span>
<span class="nl">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* An expression for conditional breakpoints.
* It is only honored by a debug adapter if the corresponding capability
* `supportsConditionalBreakpoints` is true.
*/</span>
<span class="nl">condition</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* An expression that controls how many hits of the breakpoint are ignored.
* The debug adapter is expected to interpret the expression as needed.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsHitConditionalBreakpoints` is true.
*/</span>
<span class="nl">hitCondition</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="databreakpointaccesstype">
<a name="Types_DataBreakpointAccessType" class="anchor"></a>DataBreakpointAccessType</h3>
<p>This enumeration defines all possible access types for data breakpoints.
Values: ‘read’, ‘write’, ‘readWrite’</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">type</span> <span class="nx">DataBreakpointAccessType</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">read</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">write</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">readWrite</span><span class="dl">'</span><span class="p">;</span>
</code></pre></div></div>
<h3 id="databreakpoint">
<a name="Types_DataBreakpoint" class="anchor"></a>DataBreakpoint</h3>
<p>Properties of a data breakpoint passed to the <code class="language-plaintext highlighter-rouge">setDataBreakpoints</code> request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DataBreakpoint</span> <span class="p">{</span>
<span class="cm">/**
* An id representing the data. This id is returned from the
* `dataBreakpointInfo` request.
*/</span>
<span class="nl">dataId</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The access type of the data.
*/</span>
<span class="nl">accessType</span><span class="p">?:</span> <span class="nx">DataBreakpointAccessType</span><span class="p">;</span>
<span class="cm">/**
* An expression for conditional breakpoints.
*/</span>
<span class="nl">condition</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* An expression that controls how many hits of the breakpoint are ignored.
* The debug adapter is expected to interpret the expression as needed.
*/</span>
<span class="nl">hitCondition</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="instructionbreakpoint">
<a name="Types_InstructionBreakpoint" class="anchor"></a>InstructionBreakpoint</h3>
<p>Properties of a breakpoint passed to the <code class="language-plaintext highlighter-rouge">setInstructionBreakpoints</code> request</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">InstructionBreakpoint</span> <span class="p">{</span>
<span class="cm">/**
* The instruction reference of the breakpoint.
* This should be a memory or instruction pointer reference from an
* `EvaluateResponse`, `Variable`, `StackFrame`, `GotoTarget`, or
* `Breakpoint`.
*/</span>
<span class="nl">instructionReference</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The offset from the instruction reference in bytes.
* This can be negative.
*/</span>
<span class="nl">offset</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* An expression for conditional breakpoints.
* It is only honored by a debug adapter if the corresponding capability
* `supportsConditionalBreakpoints` is true.
*/</span>
<span class="nl">condition</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* An expression that controls how many hits of the breakpoint are ignored.
* The debug adapter is expected to interpret the expression as needed.
* The attribute is only honored by a debug adapter if the corresponding
* capability `supportsHitConditionalBreakpoints` is true.
*/</span>
<span class="nl">hitCondition</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The mode of this breakpoint. If defined, this must be one of the
* `breakpointModes` the debug adapter advertised in its `Capabilities`.
*/</span>
<span class="nl">mode</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="breakpoint">
<a name="Types_Breakpoint" class="anchor"></a>Breakpoint</h3>
<p>Information about a breakpoint created in <code class="language-plaintext highlighter-rouge">setBreakpoints</code>, <code class="language-plaintext highlighter-rouge">setFunctionBreakpoints</code>, <code class="language-plaintext highlighter-rouge">setInstructionBreakpoints</code>, or <code class="language-plaintext highlighter-rouge">setDataBreakpoints</code> requests.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Breakpoint</span> <span class="p">{</span>
<span class="cm">/**
* The identifier for the breakpoint. It is needed if breakpoint events are
* used to update or remove breakpoints.
*/</span>
<span class="nl">id</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* If true, the breakpoint could be set (but not necessarily at the desired
* location).
*/</span>
<span class="nl">verified</span><span class="p">:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* A message about the state of the breakpoint.
* This is shown to the user and can be used to explain why a breakpoint could
* not be verified.
*/</span>
<span class="nl">message</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The source where the breakpoint is located.
*/</span>
<span class="nl">source</span><span class="p">?:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The start line of the actual range covered by the breakpoint.
*/</span>
<span class="nl">line</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Start position of the source range covered by the breakpoint. It is
* measured in UTF-16 code units and the client capability `columnsStartAt1`
* determines whether it is 0- or 1-based.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end line of the actual range covered by the breakpoint.
*/</span>
<span class="nl">endLine</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* End position of the source range covered by the breakpoint. It is measured
* in UTF-16 code units and the client capability `columnsStartAt1` determines
* whether it is 0- or 1-based.
* If no end line is given, then the end column is assumed to be in the start
* line.
*/</span>
<span class="nl">endColumn</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A memory reference to where the breakpoint is set.
*/</span>
<span class="nl">instructionReference</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The offset from the instruction reference.
* This can be negative.
*/</span>
<span class="nl">offset</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A machine-readable explanation of why a breakpoint may not be verified. If
* a breakpoint is verified or a specific reason is not known, the adapter
* should omit this property. Possible values include:
*
* - `pending`: Indicates a breakpoint might be verified in the future, but
* the adapter cannot verify it in the current state.
* - `failed`: Indicates a breakpoint was not able to be verified, and the
* adapter does not believe it can be verified without intervention.
* Values: 'pending', 'failed'
*/</span>
<span class="nl">reason</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">pending</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">failed</span><span class="dl">'</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="steppinggranularity">
<a name="Types_SteppingGranularity" class="anchor"></a>SteppingGranularity</h3>
<p>The granularity of one ‘step’ in the stepping requests <code class="language-plaintext highlighter-rouge">next</code>, <code class="language-plaintext highlighter-rouge">stepIn</code>, <code class="language-plaintext highlighter-rouge">stepOut</code>, and <code class="language-plaintext highlighter-rouge">stepBack</code>.
Values:</p>
<ul>
<li>‘statement’: The step should allow the program to run until the current statement has finished executing.
The meaning of a statement is determined by the adapter and it may be considered equivalent to a line.
For example ‘for(int i = 0; i < 10; i++)’ could be considered to have 3 statements ‘int i = 0’, ‘i < 10’, and ‘i++’.</li>
<li>‘line’: The step should allow the program to run until the current source line has executed.</li>
<li>‘instruction’: The step should allow one instruction to execute (e.g. one x86 instruction).</li>
</ul>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">type</span> <span class="nx">SteppingGranularity</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">statement</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">line</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">instruction</span><span class="dl">'</span><span class="p">;</span>
</code></pre></div></div>
<h3 id="stepintarget">
<a name="Types_StepInTarget" class="anchor"></a>StepInTarget</h3>
<p>A <code class="language-plaintext highlighter-rouge">StepInTarget</code> can be used in the <code class="language-plaintext highlighter-rouge">stepIn</code> request and determines into which single target the <code class="language-plaintext highlighter-rouge">stepIn</code> request should step.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StepInTarget</span> <span class="p">{</span>
<span class="cm">/**
* Unique identifier for a step-in target.
*/</span>
<span class="nl">id</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The name of the step-in target (shown in the UI).
*/</span>
<span class="nl">label</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The line of the step-in target.
*/</span>
<span class="nl">line</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Start position of the range covered by the step in target. It is measured
* in UTF-16 code units and the client capability `columnsStartAt1` determines
* whether it is 0- or 1-based.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end line of the range covered by the step-in target.
*/</span>
<span class="nl">endLine</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* End position of the range covered by the step in target. It is measured in
* UTF-16 code units and the client capability `columnsStartAt1` determines
* whether it is 0- or 1-based.
*/</span>
<span class="nl">endColumn</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="gototarget">
<a name="Types_GotoTarget" class="anchor"></a>GotoTarget</h3>
<p>A <code class="language-plaintext highlighter-rouge">GotoTarget</code> describes a code location that can be used as a target in the <code class="language-plaintext highlighter-rouge">goto</code> request.</p>
<p>The possible goto targets can be determined via the <code class="language-plaintext highlighter-rouge">gotoTargets</code> request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">GotoTarget</span> <span class="p">{</span>
<span class="cm">/**
* Unique identifier for a goto target. This is used in the `goto` request.
*/</span>
<span class="nl">id</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The name of the goto target (shown in the UI).
*/</span>
<span class="nl">label</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The line of the goto target.
*/</span>
<span class="nl">line</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The column of the goto target.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end line of the range covered by the goto target.
*/</span>
<span class="nl">endLine</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end column of the range covered by the goto target.
*/</span>
<span class="nl">endColumn</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A memory reference for the instruction pointer value represented by this
* target.
*/</span>
<span class="nl">instructionPointerReference</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="completionitem">
<a name="Types_CompletionItem" class="anchor"></a>CompletionItem</h3>
<p><code class="language-plaintext highlighter-rouge">CompletionItems</code> are the suggestions returned from the <code class="language-plaintext highlighter-rouge">completions</code> request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">CompletionItem</span> <span class="p">{</span>
<span class="cm">/**
* The label of this completion item. By default this is also the text that is
* inserted when selecting this completion.
*/</span>
<span class="nl">label</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* If text is returned and not an empty string, then it is inserted instead of
* the label.
*/</span>
<span class="nl">text</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A string that should be used when comparing this item with other items. If
* not returned or an empty string, the `label` is used instead.
*/</span>
<span class="nl">sortText</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A human-readable string with additional information about this item, like
* type or symbol information.
*/</span>
<span class="nl">detail</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The item's type. Typically the client uses this information to render the
* item in the UI with an icon.
*/</span>
<span class="nl">type</span><span class="p">?:</span> <span class="nx">CompletionItemType</span><span class="p">;</span>
<span class="cm">/**
* Start position (within the `text` attribute of the `completions` request)
* where the completion text is added. The position is measured in UTF-16 code
* units and the client capability `columnsStartAt1` determines whether it is
* 0- or 1-based. If the start position is omitted the text is added at the
* location specified by the `column` attribute of the `completions` request.
*/</span>
<span class="nl">start</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Length determines how many characters are overwritten by the completion
* text and it is measured in UTF-16 code units. If missing the value 0 is
* assumed which results in the completion text being inserted.
*/</span>
<span class="nl">length</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Determines the start of the new selection after the text has been inserted
* (or replaced). `selectionStart` is measured in UTF-16 code units and must
* be in the range 0 and length of the completion text. If omitted the
* selection starts at the end of the completion text.
*/</span>
<span class="nl">selectionStart</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* Determines the length of the new selection after the text has been inserted
* (or replaced) and it is measured in UTF-16 code units. The selection can
* not extend beyond the bounds of the completion text. If omitted the length
* is assumed to be 0.
*/</span>
<span class="nl">selectionLength</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="completionitemtype">
<a name="Types_CompletionItemType" class="anchor"></a>CompletionItemType</h3>
<p>Some predefined types for the CompletionItem. Please note that not all clients have specific icons for all of them.
Values: ‘method’, ‘function’, ‘constructor’, ‘field’, ‘variable’, ‘class’, ‘interface’, ‘module’, ‘property’, ‘unit’, ‘value’, ‘enum’, ‘keyword’, ‘snippet’, ‘text’, ‘color’, ‘file’, ‘reference’, ‘customcolor’</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">type</span> <span class="nx">CompletionItemType</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">method</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">function</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">constructor</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">field</span><span class="dl">'</span>
<span class="o">|</span> <span class="dl">'</span><span class="s1">variable</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">class</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">interface</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">module</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">property</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">unit</span><span class="dl">'</span>
<span class="o">|</span> <span class="dl">'</span><span class="s1">value</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">enum</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">keyword</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">snippet</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">text</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">color</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">file</span><span class="dl">'</span>
<span class="o">|</span> <span class="dl">'</span><span class="s1">reference</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">customcolor</span><span class="dl">'</span><span class="p">;</span>
</code></pre></div></div>
<h3 id="checksumalgorithm">
<a name="Types_ChecksumAlgorithm" class="anchor"></a>ChecksumAlgorithm</h3>
<p>Names of checksum algorithms that may be supported by a debug adapter.
Values: ‘MD5’, ‘SHA1’, ‘SHA256’, ‘timestamp’</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">type</span> <span class="nx">ChecksumAlgorithm</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">MD5</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">SHA1</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">SHA256</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">timestamp</span><span class="dl">'</span><span class="p">;</span>
</code></pre></div></div>
<h3 id="checksum">
<a name="Types_Checksum" class="anchor"></a>Checksum</h3>
<p>The checksum of an item calculated by the specified algorithm.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">Checksum</span> <span class="p">{</span>
<span class="cm">/**
* The algorithm used to calculate this checksum.
*/</span>
<span class="nl">algorithm</span><span class="p">:</span> <span class="nx">ChecksumAlgorithm</span><span class="p">;</span>
<span class="cm">/**
* Value of the checksum, encoded as a hexadecimal value.
*/</span>
<span class="nl">checksum</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="valueformat">
<a name="Types_ValueFormat" class="anchor"></a>ValueFormat</h3>
<p>Provides formatting information for a value.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ValueFormat</span> <span class="p">{</span>
<span class="cm">/**
* Display the value in hex.
*/</span>
<span class="nl">hex</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="stackframeformat">
<a name="Types_StackFrameFormat" class="anchor"></a>StackFrameFormat</h3>
<p>Provides formatting information for a stack frame.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">StackFrameFormat</span> <span class="kd">extends</span> <span class="nx">ValueFormat</span> <span class="p">{</span>
<span class="cm">/**
* Displays parameters for the stack frame.
*/</span>
<span class="nl">parameters</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Displays the types of parameters for the stack frame.
*/</span>
<span class="nl">parameterTypes</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Displays the names of parameters for the stack frame.
*/</span>
<span class="nl">parameterNames</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Displays the values of parameters for the stack frame.
*/</span>
<span class="nl">parameterValues</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Displays the line number of the stack frame.
*/</span>
<span class="nl">line</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Displays the module of the stack frame.
*/</span>
<span class="nl">module</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Includes all stack frames, including those the debug adapter might
* otherwise hide.
*/</span>
<span class="nl">includeAll</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="exceptionfilteroptions">
<a name="Types_ExceptionFilterOptions" class="anchor"></a>ExceptionFilterOptions</h3>
<p>An <code class="language-plaintext highlighter-rouge">ExceptionFilterOptions</code> is used to specify an exception filter together with a condition for the <code class="language-plaintext highlighter-rouge">setExceptionBreakpoints</code> request.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ExceptionFilterOptions</span> <span class="p">{</span>
<span class="cm">/**
* ID of an exception filter returned by the `exceptionBreakpointFilters`
* capability.
*/</span>
<span class="nl">filterId</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* An expression for conditional exceptions.
* The exception breaks into the debugger if the result of the condition is
* true.
*/</span>
<span class="nl">condition</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The mode of this exception breakpoint. If defined, this must be one of the
* `breakpointModes` the debug adapter advertised in its `Capabilities`.
*/</span>
<span class="nl">mode</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="exceptionoptions">
<a name="Types_ExceptionOptions" class="anchor"></a>ExceptionOptions</h3>
<p>An <code class="language-plaintext highlighter-rouge">ExceptionOptions</code> assigns configuration options to a set of exceptions.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ExceptionOptions</span> <span class="p">{</span>
<span class="cm">/**
* A path that selects a single or multiple exceptions in a tree. If `path` is
* missing, the whole tree is selected.
* By convention the first segment of the path is a category that is used to
* group exceptions in the UI.
*/</span>
<span class="nl">path</span><span class="p">?:</span> <span class="nx">ExceptionPathSegment</span><span class="p">[];</span>
<span class="cm">/**
* Condition when a thrown exception should result in a break.
*/</span>
<span class="nl">breakMode</span><span class="p">:</span> <span class="nx">ExceptionBreakMode</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="exceptionbreakmode">
<a name="Types_ExceptionBreakMode" class="anchor"></a>ExceptionBreakMode</h3>
<p>This enumeration defines all possible conditions when a thrown exception should result in a break.</p>
<p>never: never breaks,</p>
<p>always: always breaks,</p>
<p>unhandled: breaks when exception unhandled,</p>
<p>userUnhandled: breaks if the exception is not handled by user code.
Values: ‘never’, ‘always’, ‘unhandled’, ‘userUnhandled’</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">type</span> <span class="nx">ExceptionBreakMode</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">never</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">always</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">unhandled</span><span class="dl">'</span>
<span class="o">|</span> <span class="dl">'</span><span class="s1">userUnhandled</span><span class="dl">'</span><span class="p">;</span>
</code></pre></div></div>
<h3 id="exceptionpathsegment">
<a name="Types_ExceptionPathSegment" class="anchor"></a>ExceptionPathSegment</h3>
<p>An <code class="language-plaintext highlighter-rouge">ExceptionPathSegment</code> represents a segment in a path that is used to match leafs or nodes in a tree of exceptions.</p>
<p>If a segment consists of more than one name, it matches the names provided if <code class="language-plaintext highlighter-rouge">negate</code> is false or missing, or it matches anything except the names provided if <code class="language-plaintext highlighter-rouge">negate</code> is true.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ExceptionPathSegment</span> <span class="p">{</span>
<span class="cm">/**
* If false or missing this segment matches the names provided, otherwise it
* matches anything except the names provided.
*/</span>
<span class="nl">negate</span><span class="p">?:</span> <span class="nx">boolean</span><span class="p">;</span>
<span class="cm">/**
* Depending on the value of `negate` the names that should match or not
* match.
*/</span>
<span class="nl">names</span><span class="p">:</span> <span class="kr">string</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="exceptiondetails">
<a name="Types_ExceptionDetails" class="anchor"></a>ExceptionDetails</h3>
<p>Detailed information about an exception that has occurred.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">ExceptionDetails</span> <span class="p">{</span>
<span class="cm">/**
* Message contained in the exception.
*/</span>
<span class="nl">message</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Short type name of the exception object.
*/</span>
<span class="nl">typeName</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Fully-qualified type name of the exception object.
*/</span>
<span class="nl">fullTypeName</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* An expression that can be evaluated in the current scope to obtain the
* exception object.
*/</span>
<span class="nl">evaluateName</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Stack trace at the time the exception was thrown.
*/</span>
<span class="nl">stackTrace</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Details of the exception contained by this exception, if any.
*/</span>
<span class="nl">innerException</span><span class="p">?:</span> <span class="nx">ExceptionDetails</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="disassembledinstruction">
<a name="Types_DisassembledInstruction" class="anchor"></a>DisassembledInstruction</h3>
<p>Represents a single disassembled instruction.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">DisassembledInstruction</span> <span class="p">{</span>
<span class="cm">/**
* The address of the instruction. Treated as a hex value if prefixed with
* `0x`, or as a decimal value otherwise.
*/</span>
<span class="nl">address</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Raw bytes representing the instruction and its operands, in an
* implementation-defined format.
*/</span>
<span class="nl">instructionBytes</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Text representing the instruction and its operands, in an
* implementation-defined format.
*/</span>
<span class="nl">instruction</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Name of the symbol that corresponds with the location of this instruction,
* if any.
*/</span>
<span class="nl">symbol</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Source location that corresponds to this instruction, if any.
* Should always be set (if available) on the first instruction returned,
* but can be omitted afterwards if this instruction maps to the same source
* file as the previous instruction.
*/</span>
<span class="nl">location</span><span class="p">?:</span> <span class="nx">Source</span><span class="p">;</span>
<span class="cm">/**
* The line within the source location that corresponds to this instruction,
* if any.
*/</span>
<span class="nl">line</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The column within the line that corresponds to this instruction, if any.
*/</span>
<span class="nl">column</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end line of the range that corresponds to this instruction, if any.
*/</span>
<span class="nl">endLine</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* The end column of the range that corresponds to this instruction, if any.
*/</span>
<span class="nl">endColumn</span><span class="p">?:</span> <span class="kr">number</span><span class="p">;</span>
<span class="cm">/**
* A hint for how to present the instruction in the UI.
*
* A value of `invalid` may be used to indicate this instruction is 'filler'
* and cannot be reached by the program. For example, unreadable memory
* addresses may be presented is 'invalid.'
* Values: 'normal', 'invalid'
*/</span>
<span class="nl">presentationHint</span><span class="p">?:</span> <span class="dl">'</span><span class="s1">normal</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">invalid</span><span class="dl">'</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="invalidatedareas">
<a name="Types_InvalidatedAreas" class="anchor"></a>InvalidatedAreas</h3>
<p>Logical areas that can be invalidated by the <code class="language-plaintext highlighter-rouge">invalidated</code> event.
Values:</p>
<ul>
<li>‘all’: All previously fetched data has become invalid and needs to be refetched.</li>
<li>‘stacks’: Previously fetched stack related data has become invalid and needs to be refetched.</li>
<li>‘threads’: Previously fetched thread related data has become invalid and needs to be refetched.</li>
<li>‘variables’: Previously fetched variable data has become invalid and needs to be refetched.
etc.</li>
</ul>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">export</span> <span class="kd">type</span> <span class="nx">InvalidatedAreas</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">all</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">stacks</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">threads</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">variables</span><span class="dl">'</span>
<span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
</code></pre></div></div>
<h3 id="breakpointmode">
<a name="Types_BreakpointMode" class="anchor"></a>BreakpointMode</h3>
<p>A <code class="language-plaintext highlighter-rouge">BreakpointMode</code> is provided as a option when setting breakpoints on sources or instructions.</p>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kr">interface</span> <span class="nx">BreakpointMode</span> <span class="p">{</span>
<span class="cm">/**
* The internal ID of the mode. This value is passed to the `setBreakpoints`
* request.
*/</span>
<span class="nl">mode</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* The name of the breakpoint mode. This is shown in the UI.
*/</span>
<span class="nl">label</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* A help text providing additional information about the breakpoint mode.
* This string is typically shown as a hover and can be translated.
*/</span>
<span class="nl">description</span><span class="p">?:</span> <span class="kr">string</span><span class="p">;</span>
<span class="cm">/**
* Describes one or more type of breakpoint this mode applies to.
*/</span>
<span class="nl">appliesTo</span><span class="p">:</span> <span class="nx">BreakpointModeApplicability</span><span class="p">[];</span>
<span class="p">}</span>
</code></pre></div></div>
<h3 id="breakpointmodeapplicability">
<a name="Types_BreakpointModeApplicability" class="anchor"></a>BreakpointModeApplicability</h3>
<p>Describes one or more type of breakpoint a <code class="language-plaintext highlighter-rouge">BreakpointMode</code> applies to. This is a non-exhaustive enumeration and may expand as future breakpoint types are added.
Values:</p>
<ul>
<li>‘source’: In <code class="language-plaintext highlighter-rouge">SourceBreakpoint</code>s</li>
<li>‘exception’: In exception breakpoints applied in the <code class="language-plaintext highlighter-rouge">ExceptionFilterOptions</code>
</li>
<li>‘data’: In data breakpoints requested in the <code class="language-plaintext highlighter-rouge">DataBreakpointInfo</code> request</li>
<li>‘instruction’: In <code class="language-plaintext highlighter-rouge">InstructionBreakpoint</code>s
etc.</li>
</ul>
<div class="language-typescript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">export</span> <span class="kd">type</span> <span class="nx">BreakpointModeApplicability</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">source</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">exception</span><span class="dl">'</span> <span class="o">|</span> <span class="dl">'</span><span class="s1">data</span><span class="dl">'</span>
<span class="o">|</span> <span class="dl">'</span><span class="s1">instruction</span><span class="dl">'</span> <span class="o">|</span> <span class="kr">string</span><span class="p">;</span>
</code></pre></div></div>
</div>
</div>
<div class="d-none col-lg-3 d-lg-block dap-sidebar">
<div class="card">
<div id="outlineAccordion-side" data-children=".item">
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-side" href="#Base_Protocol-side" aria-expanded="true">
Base Protocol
</a>
<div id="Base_Protocol-side" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_Cancel">
Cancel
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_ErrorResponse">
ErrorResponse
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_Event">
Event
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_ProtocolMessage">
ProtocolMessage
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_Request">
Request
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Base_Protocol_Response">
Response
</a>
</li>
</ul>
</div>
</div>
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-side" href="#Events-side" aria-expanded="true">
Events
</a>
<div id="Events-side" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Breakpoint">
Breakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Capabilities">
Capabilities
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Continued">
Continued
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Exited">
Exited
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Initialized">
Initialized
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Invalidated">
Invalidated
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_LoadedSource">
LoadedSource
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Memory">
Memory
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Module">
Module
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Output">
Output
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Process">
Process
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_ProgressEnd">
ProgressEnd
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_ProgressStart">
ProgressStart
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_ProgressUpdate">
ProgressUpdate
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Stopped">
Stopped
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Terminated">
Terminated
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Events_Thread">
Thread
</a>
</li>
</ul>
</div>
</div>
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-side" href="#Requests-side" aria-expanded="true">
Requests
</a>
<div id="Requests-side" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Attach">
Attach
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_BreakpointLocations">
BreakpointLocations
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Completions">
Completions
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_ConfigurationDone">
ConfigurationDone
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Continue">
Continue
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_DataBreakpointInfo">
DataBreakpointInfo
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Disassemble">
Disassemble
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Disconnect">
Disconnect
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Evaluate">
Evaluate
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_ExceptionInfo">
ExceptionInfo
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Goto">
Goto
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_GotoTargets">
GotoTargets
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Initialize">
Initialize
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Launch">
Launch
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_LoadedSources">
LoadedSources
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Locations">
Locations
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Modules">
Modules
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Next">
Next
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Pause">
Pause
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_ReadMemory">
ReadMemory
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Restart">
Restart
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_RestartFrame">
RestartFrame
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_ReverseContinue">
ReverseContinue
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Scopes">
Scopes
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetBreakpoints">
SetBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetDataBreakpoints">
SetDataBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetExceptionBreakpoints">
SetExceptionBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetExpression">
SetExpression
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetFunctionBreakpoints">
SetFunctionBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetInstructionBreakpoints">
SetInstructionBreakpoints
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_SetVariable">
SetVariable
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Source">
Source
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StackTrace">
StackTrace
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StepBack">
StepBack
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StepIn">
StepIn
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StepInTargets">
StepInTargets
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_StepOut">
StepOut
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Terminate">
Terminate
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_TerminateThreads">
TerminateThreads
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Threads">
Threads
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_Variables">
Variables
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Requests_WriteMemory">
WriteMemory
</a>
</li>
</ul>
</div>
</div>
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-side" href="#Reverse_Requests-side" aria-expanded="true">
Reverse Requests
</a>
<div id="Reverse_Requests-side" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Reverse_Requests_RunInTerminal">
RunInTerminal
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Reverse_Requests_StartDebugging">
StartDebugging
</a>
</li>
</ul>
</div>
</div>
<div class="item">
<a class="nav-link" data-toggle="collapse" data-parent="#outlineAccordion-side" href="#Types-side" aria-expanded="true">
Types
</a>
<div id="Types-side" class="collapse" role="tabpanel">
<ul class="nav toc flex-column" style="padding-left: 0.5rem">
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Breakpoint">
Breakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_BreakpointLocation">
BreakpointLocation
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_BreakpointMode">
BreakpointMode
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_BreakpointModeApplicability">
BreakpointModeApplicability
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Capabilities">
Capabilities
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Checksum">
Checksum
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ChecksumAlgorithm">
ChecksumAlgorithm
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ColumnDescriptor">
ColumnDescriptor
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_CompletionItem">
CompletionItem
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_CompletionItemType">
CompletionItemType
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_DataBreakpoint">
DataBreakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_DataBreakpointAccessType">
DataBreakpointAccessType
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_DisassembledInstruction">
DisassembledInstruction
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionBreakMode">
ExceptionBreakMode
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionBreakpointsFilter">
ExceptionBreakpointsFilter
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionDetails">
ExceptionDetails
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionFilterOptions">
ExceptionFilterOptions
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionOptions">
ExceptionOptions
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ExceptionPathSegment">
ExceptionPathSegment
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_FunctionBreakpoint">
FunctionBreakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_GotoTarget">
GotoTarget
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_InstructionBreakpoint">
InstructionBreakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_InvalidatedAreas">
InvalidatedAreas
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Message">
Message
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Module">
Module
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Scope">
Scope
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Source">
Source
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_SourceBreakpoint">
SourceBreakpoint
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_StackFrame">
StackFrame
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_StackFrameFormat">
StackFrameFormat
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_StepInTarget">
StepInTarget
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_SteppingGranularity">
SteppingGranularity
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Thread">
Thread
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_ValueFormat">
ValueFormat
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_Variable">
Variable
</a>
</li>
<li class="nav-item">
<a class="nav-link toc-link" href="#Types_VariablePresentationHint">
VariablePresentationHint
</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<script>
function manageConsent() {
if (WcpConsent.siteConsent.isConsentRequired) {
WcpConsent.siteConsent.manageConsent();
}
}
</script>
<div class="container">
<div class="row">
<div class="col-sm-8">
<ul class="links">
<li>
<span class="message">Hello from Seattle and Zürich.</span>
</li>
<li class="github-button-container">
<a class="github-button" href="https://github.com/Microsoft/debug-adapter-protocol" data-icon="octicon-star" data-show-count="true" aria-label="Star Microsoft/debug-adapter-protocol on GitHub">Star</a>
</li>
<li class="github-button-container">
<a class="github-button" href="https://github.com/Microsoft/debug-adapter-protocol/subscription" aria-label="Watch Microsoft/debug-adapter-protocol on GitHub">Watch</a>
</li>
</ul>
</div>
<div class="col-sm-4">
<ul class="links">
<li style="visibility: hidden;">
<a id="footer-cookie-link" style="cursor: pointer; padding-right:20px" onclick="manageConsent()" aria-label="Manage cookies">Manage cookies</a>
</li>
<li>
<div class="copyright">
<a id="footer-microsoft-link" class="logo" href="https://www.microsoft.com">
<picture>
<source srcset="/debug-adapter-protocol/img/microsoft-logo.png" media="(prefers-color-scheme: dark)"></source>
<img src="/debug-adapter-protocol/img/microsoft-logo-inverted.png" height="20" alt="Microsoft">
</picture>
</a>
<span>© 2026 Microsoft</span>
</div>
</li>
</ul>
</div>
</div>
</div>
</footer>
<script>
var baseurl = '/debug-adapter-protocol'
</script>
<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
<!-- Microsoft EU cookie compliance library -->
<script src="https://wcpstatic.microsoft.com/mscc/lib/v2/wcp-consent.js"></script>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-62780441-30"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.3/umd/popper.min.js" integrity="sha384-vFJXuSJphROIrBnz7yo7oB41mKfc8JzQZiCq4NCceLEaO4IHwicKwpJf9c9IpFgh" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta.2/js/bootstrap.min.js" integrity="sha384-alpBpkh1PFOepccYVYDB4do5UnbKysX5WZXm3XxPqe5iKTfUKjNkCk9SaVuEZflJ" crossorigin="anonymous"></script>
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script src="/debug-adapter-protocol/js/page.js"></script>
</body>
</html>