Debug Adapter Protocol

The Debug Adapter Protocol defines the protocol used between an editor or IDE and a debugger or runtime.

The change history of the specification can be found here.

Base Protocol

ProtocolMessage

Base class of requests, responses, and events.

interface ProtocolMessage {
  /**
   * Sequence number.
   */
  seq: number;

  /**
   * Message type.
   * Values: 'request', 'response', 'event', etc.
   */
  type: string;
}

Request

A client or debug adapter initiated request.

interface Request extends ProtocolMessage {
  type: 'request';

  /**
   * The command to execute.
   */
  command: string;

  /**
   * Object containing arguments for the command.
   */
  arguments?: any;
}

Event

A debug adapter initiated event.

interface Event extends ProtocolMessage {
  type: 'event';

  /**
   * Type of event.
   */
  event: string;

  /**
   * Event-specific information.
   */
  body?: any;
}

Response

Response for a request.

interface Response extends ProtocolMessage {
  type: 'response';

  /**
   * Sequence number of the corresponding request.
   */
  request_seq: number;

  /**
   * Outcome of the request.
   */
  success: boolean;

  /**
   * The command requested.
   */
  command: string;

  /**
   * Contains error message if success == false.
   */
  message?: string;

  /**
   * Contains request result if success is true and optional error details if success is false.
   */
  body?: any;
}

ErrorResponse

On error (whenever ‘success’ is false), the body can provide more details.

interface ErrorResponse extends Response {
  body: {
    /**
     * An optional, structured error message.
     */
    error?: Message;
  };
}

Events

:arrow_left: Initialized Event

This event indicates that the debug adapter is ready to accept configuration requests (e.g. SetBreakpointsRequest, SetExceptionBreakpointsRequest).

A debug adapter is expected to send this event when it is ready to accept configuration requests (but not before the ‘initialize’ request has finished).

The sequence of events/requests is as follows:

  • adapters sends ‘initialized’ event (after the ‘initialize’ request has returned)
  • frontend sends zero or more ‘setBreakpoints’ requests
  • frontend sends one ‘setFunctionBreakpoints’ request
  • frontend sends a ‘setExceptionBreakpoints’ request if one or more ‘exceptionBreakpointFilters’ have been defined (or if ‘supportsConfigurationDoneRequest’ is not defined or false)
  • frontend sends other future configuration requests
  • frontend sends one ‘configurationDone’ request to indicate the end of the configuration.
interface InitializedEvent extends Event {
  event: 'initialized';
}

:arrow_left: Stopped Event

The event indicates that the execution of the debuggee has stopped due to some condition.

This can be caused by a break point previously set, a stepping action has completed, by executing a debugger statement etc.

interface StoppedEvent extends Event {
  event: 'stopped';

  body: {
    /**
     * 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', etc.
     */
    reason: string;

    /**
     * The full reason for the event, e.g. 'Paused on exception'. This string is shown in the UI as is and must be translated.
     */
    description?: string;

    /**
     * The thread which was stopped.
     */
    threadId?: number;

    /**
     * A value of true hints to the frontend that this event should not change the focus.
     */
    preserveFocusHint?: boolean;

    /**
     * Additional information. E.g. if reason is 'exception', text contains the exception name. This string is shown in the UI.
     */
    text?: string;

    /**
     * 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.
     */
    allThreadsStopped?: boolean;
  };
}

:arrow_left: Continued Event

The event indicates that the execution of the debuggee has continued.

Please note: a debug adapter is not expected to send this event in response to a request that implies that execution continues, e.g. ‘launch’ or ‘continue’.

It is only necessary to send a ‘continued’ event if there was no previous request that implied this.

interface ContinuedEvent extends Event {
  event: 'continued';

  body: {
    /**
     * The thread which was continued.
     */
    threadId: number;

    /**
     * If 'allThreadsContinued' is true, a debug adapter can announce that all threads have continued.
     */
    allThreadsContinued?: boolean;
  };
}

:arrow_left: Exited Event

The event indicates that the debuggee has exited and returns its exit code.

interface ExitedEvent extends Event {
  event: 'exited';

  body: {
    /**
     * The exit code returned from the debuggee.
     */
    exitCode: number;
  };
}

:arrow_left: Terminated Event

The event indicates that debugging of the debuggee has terminated. This does not mean that the debuggee itself has exited.

interface TerminatedEvent extends Event {
  event: 'terminated';

  body?: {
    /**
     * A debug adapter may set 'restart' to true (or to an arbitrary object) to request that the front end restarts the session.
     * The value is not interpreted by the client and passed unmodified as an attribute '__restart' to the 'launch' and 'attach' requests.
     */
    restart?: any;
  };
}

:arrow_left: Thread Event

The event indicates that a thread has started or exited.

interface ThreadEvent extends Event {
  event: 'thread';

  body: {
    /**
     * The reason for the event.
     * Values: 'started', 'exited', etc.
     */
    reason: string;

    /**
     * The identifier of the thread.
     */
    threadId: number;
  };
}

:arrow_left: Output Event

The event indicates that the target has produced some output.

interface OutputEvent extends Event {
  event: 'output';

  body: {
    /**
     * The output category. If not specified, 'console' is assumed.
     * Values: 'console', 'stdout', 'stderr', 'telemetry', etc.
     */
    category?: string;

    /**
     * The output to report.
     */
    output: string;

    /**
     * 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.
     */
    variablesReference?: number;

    /**
     * An optional source location where the output was produced.
     */
    source?: Source;

    /**
     * An optional source location line where the output was produced.
     */
    line?: number;

    /**
     * An optional source location column where the output was produced.
     */
    column?: number;

    /**
     * Optional data to report. For the 'telemetry' category the data will be sent to telemetry, for the other categories the data is shown in JSON format.
     */
    data?: any;
  };
}

:arrow_left: Breakpoint Event

The event indicates that some information about a breakpoint has changed.

interface BreakpointEvent extends Event {
  event: 'breakpoint';

  body: {
    /**
     * The reason for the event.
     * Values: 'changed', 'new', 'removed', etc.
     */
    reason: string;

    /**
     * The 'id' attribute is used to find the target breakpoint and the other attributes are used as the new values.
     */
    breakpoint: Breakpoint;
  };
}

:arrow_left: Module Event

The event indicates that some information about a module has changed.

interface ModuleEvent extends Event {
  event: 'module';

  body: {
    /**
     * The reason for the event.
     */
    reason: 'new' | 'changed' | 'removed';

    /**
     * The new, changed, or removed module. In case of 'removed' only the module id is used.
     */
    module: Module;
  };
}

:arrow_left: LoadedSource Event

The event indicates that some source has been added, changed, or removed from the set of all loaded sources.

interface LoadedSourceEvent extends Event {
  event: 'loadedSource';

  body: {
    /**
     * The reason for the event.
     */
    reason: 'new' | 'changed' | 'removed';

    /**
     * The new, changed, or removed source.
     */
    source: Source;
  };
}

:arrow_left: Process Event

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.

interface ProcessEvent extends Event {
  event: 'process';

  body: {
    /**
     * The logical name of the process. This is usually the full path to process's executable file. Example: /home/example/myproj/program.js.
     */
    name: string;

    /**
     * The system process id of the debugged process. This property will be missing for non-system processes.
     */
    systemProcessId?: number;

    /**
     * If true, the process is running on the same computer as the debug adapter.
     */
    isLocalProcess?: boolean;

    /**
     * Describes how the debug engine started debugging this process.
     * '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.
     */
    startMethod?: 'launch' | 'attach' | 'attachForSuspendedLaunch';
  };
}

:arrow_left: Capabilities Event

The event indicates that one or more capabilities have changed.

Since the capabilities are dependent on the frontend and its UI, it might not be possible to change that at random times (or too late).

Consequently this event has a hint characteristic: a frontend can only be expected to make a ‘best effort’ in honouring individual capabilities but there are no guarantees.

Only changed capabilities need to be included, all other capabilities keep their values.

interface CapabilitiesEvent extends Event {
  event: 'capabilities';

  body: {
    /**
     * The set of updated capabilities.
     */
    capabilities: Capabilities;
  };
}

Reverse Requests

:arrow_right_hook: RunInTerminal Request

This request is sent from the debug adapter to the client to run a command in a terminal. This is typically used to launch the debuggee in a terminal provided by the client.

interface RunInTerminalRequest extends Request {
  command: 'runInTerminal';

  arguments: RunInTerminalRequestArguments;
}

Arguments for ‘runInTerminal’ request.

interface RunInTerminalRequestArguments {
  /**
   * What kind of terminal to launch.
   */
  kind?: 'integrated' | 'external';

  /**
   * Optional title of the terminal.
   */
  title?: string;

  /**
   * Working directory of the command.
   */
  cwd: string;

  /**
   * List of arguments. The first argument is the command to run.
   */
  args: string[];

  /**
   * Environment key-value pairs that are added to or removed from the default environment.
   */
  env?: { [key: string]: string | null; };
}

Response to ‘runInTerminal’ request.

interface RunInTerminalResponse extends Response {
  body: {
    /**
     * The process ID.
     */
    processId?: number;

    /**
     * The process ID of the terminal shell.
     */
    shellProcessId?: number;
  };
}

Requests

:leftwards_arrow_with_hook: Initialize Request

The ‘initialize’ 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.

Until the debug adapter has responded to with an ‘initialize’ response, the client must not send any additional requests or events to the debug adapter. In addition the debug adapter is not allowed to send any requests or events to the client until it has responded with an ‘initialize’ response.

The ‘initialize’ request may only be sent once.

interface InitializeRequest extends Request {
  command: 'initialize';

  arguments: InitializeRequestArguments;
}

Arguments for ‘initialize’ request.

interface InitializeRequestArguments {
  /**
   * The ID of the (frontend) client using this adapter.
   */
  clientID?: string;

  /**
   * The human readable name of the (frontend) client using this adapter.
   */
  clientName?: string;

  /**
   * The ID of the debug adapter.
   */
  adapterID: string;

  /**
   * The ISO-639 locale of the (frontend) client using this adapter, e.g. en-US or de-CH.
   */
  locale?: string;

  /**
   * If true all line numbers are 1-based (default).
   */
  linesStartAt1?: boolean;

  /**
   * If true all column numbers are 1-based (default).
   */
  columnsStartAt1?: boolean;

  /**
   * Determines in what format paths are specified. The default is 'path', which is the native format.
   * Values: 'path', 'uri', etc.
   */
  pathFormat?: string;

  /**
   * Client supports the optional type attribute for variables.
   */
  supportsVariableType?: boolean;

  /**
   * Client supports the paging of variables.
   */
  supportsVariablePaging?: boolean;

  /**
   * Client supports the runInTerminal request.
   */
  supportsRunInTerminalRequest?: boolean;
}

Response to ‘initialize’ request.

interface InitializeResponse extends Response {
  /**
   * The capabilities of this debug adapter.
   */
  body?: Capabilities;
}

:leftwards_arrow_with_hook: ConfigurationDone Request

The client of the debug protocol must send this request at the end of the sequence of configuration requests (which was started by the ‘initialized’ event).

interface ConfigurationDoneRequest extends Request {
  command: 'configurationDone';

  arguments?: ConfigurationDoneArguments;
}

Arguments for ‘configurationDone’ request.

interface ConfigurationDoneArguments {
}

Response to ‘configurationDone’ request. This is just an acknowledgement, so no body field is required.

interface ConfigurationDoneResponse extends Response {
}

:leftwards_arrow_with_hook: Launch Request

The launch request is sent from the client to the debug adapter to start the debuggee with or without debugging (if ‘noDebug’ is true). Since launching is debugger/runtime specific, the arguments for this request are not part of this specification.

interface LaunchRequest extends Request {
  command: 'launch';

  arguments: LaunchRequestArguments;
}

Arguments for ‘launch’ request. Additional attributes are implementation specific.

interface LaunchRequestArguments {
  /**
   * If noDebug is true the launch request should launch the program without enabling debugging.
   */
  noDebug?: boolean;

  /**
   * Optional 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.
   */
  __restart?: any;
}

Response to ‘launch’ request. This is just an acknowledgement, so no body field is required.

interface LaunchResponse extends Response {
}

:leftwards_arrow_with_hook: Attach Request

The attach request is sent from the client to the debug adapter to attach to a debuggee that is already running. Since attaching is debugger/runtime specific, the arguments for this request are not part of this specification.

interface AttachRequest extends Request {
  command: 'attach';

  arguments: AttachRequestArguments;
}

Arguments for ‘attach’ request. Additional attributes are implementation specific.

interface AttachRequestArguments {
  /**
   * Optional 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.
   */
  __restart?: any;
}

Response to ‘attach’ request. This is just an acknowledgement, so no body field is required.

interface AttachResponse extends Response {
}

:leftwards_arrow_with_hook: Restart Request

Restarts a debug session. If the capability ‘supportsRestartRequest’ is missing or has the value false,

the client will implement ‘restart’ by terminating the debug adapter first and then launching it anew.

A debug adapter can override this default behaviour by implementing a restart request

and setting the capability ‘supportsRestartRequest’ to true.

interface RestartRequest extends Request {
  command: 'restart';

  arguments?: RestartArguments;
}

Arguments for ‘restart’ request.

interface RestartArguments {
}

Response to ‘restart’ request. This is just an acknowledgement, so no body field is required.

interface RestartResponse extends Response {
}

:leftwards_arrow_with_hook: Disconnect Request

The ‘disconnect’ request is sent from the client to the debug adapter in order to stop debugging. It asks the debug adapter to disconnect from the debuggee and to terminate the debug adapter. If the debuggee has been started with the ‘launch’ request, the ‘disconnect’ request terminates the debuggee. If the ‘attach’ request was used to connect to the debuggee, ‘disconnect’ does not terminate the debuggee. This behavior can be controlled with the ‘terminateDebuggee’ argument (if supported by the debug adapter).

interface DisconnectRequest extends Request {
  command: 'disconnect';

  arguments?: DisconnectArguments;
}

Arguments for ‘disconnect’ request.

interface DisconnectArguments {
  /**
   * A value of true indicates that this 'disconnect' request is part of a restart sequence.
   */
  restart?: boolean;

  /**
   * 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.
   * A client can only rely on this attribute being properly honored if a debug adapter returns true for the 'supportTerminateDebuggee' capability.
   */
  terminateDebuggee?: boolean;
}

Response to ‘disconnect’ request. This is just an acknowledgement, so no body field is required.

interface DisconnectResponse extends Response {
}

:leftwards_arrow_with_hook: Terminate Request

The ‘terminate’ request is sent from the client to the debug adapter in order to give the debuggee a chance for terminating itself.

interface TerminateRequest extends Request {
  command: 'terminate';

  arguments?: TerminateArguments;
}

Arguments for ‘terminate’ request.

interface TerminateArguments {
  /**
   * A value of true indicates that this 'terminate' request is part of a restart sequence.
   */
  restart?: boolean;
}

Response to ‘terminate’ request. This is just an acknowledgement, so no body field is required.

interface TerminateResponse extends Response {
}

:leftwards_arrow_with_hook: SetBreakpoints Request

Sets multiple breakpoints for a single source and clears all previous breakpoints in that source.

To clear all breakpoint for a source, specify an empty array.

When a breakpoint is hit, a ‘stopped’ event (with reason ‘breakpoint’) is generated.

interface SetBreakpointsRequest extends Request {
  command: 'setBreakpoints';

  arguments: SetBreakpointsArguments;
}

Arguments for ‘setBreakpoints’ request.

interface SetBreakpointsArguments {
  /**
   * The source location of the breakpoints; either 'source.path' or 'source.reference' must be specified.
   */
  source: Source;

  /**
   * The code locations of the breakpoints.
   */
  breakpoints?: SourceBreakpoint[];

  /**
   * Deprecated: The code locations of the breakpoints.
   */
  lines?: number[];

  /**
   * A value of true indicates that the underlying source has been modified which results in new breakpoint locations.
   */
  sourceModified?: boolean;
}

Response to ‘setBreakpoints’ request.

Returned is information about each breakpoint created by this request.

This includes the actual code location and whether the breakpoint could be verified.

The breakpoints returned are in the same order as the elements of the ‘breakpoints’

(or the deprecated ‘lines’) array in the arguments.

interface SetBreakpointsResponse extends Response {
  body: {
    /**
     * 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.
     */
    breakpoints: Breakpoint[];
  };
}

:leftwards_arrow_with_hook: SetFunctionBreakpoints Request

Sets multiple function breakpoints and clears all previous function breakpoints.

To clear all function breakpoint, specify an empty array.

When a function breakpoint is hit, a ‘stopped’ event (event type ‘function breakpoint’) is generated.

interface SetFunctionBreakpointsRequest extends Request {
  command: 'setFunctionBreakpoints';

  arguments: SetFunctionBreakpointsArguments;
}

Arguments for ‘setFunctionBreakpoints’ request.

interface SetFunctionBreakpointsArguments {
  /**
   * The function names of the breakpoints.
   */
  breakpoints: FunctionBreakpoint[];
}

Response to ‘setFunctionBreakpoints’ request.

Returned is information about each breakpoint created by this request.

interface SetFunctionBreakpointsResponse extends Response {
  body: {
    /**
     * Information about the breakpoints. The array elements correspond to the elements of the 'breakpoints' array.
     */
    breakpoints: Breakpoint[];
  };
}

:leftwards_arrow_with_hook: SetExceptionBreakpoints Request

The request configures the debuggers response to thrown exceptions. If an exception is configured to break, a ‘stopped’ event is fired (with reason ‘exception’).

interface SetExceptionBreakpointsRequest extends Request {
  command: 'setExceptionBreakpoints';

  arguments: SetExceptionBreakpointsArguments;
}

Arguments for ‘setExceptionBreakpoints’ request.

interface SetExceptionBreakpointsArguments {
  /**
   * IDs of checked exception options. The set of IDs is returned via the 'exceptionBreakpointFilters' capability.
   */
  filters: string[];

  /**
   * Configuration options for selected exceptions.
   */
  exceptionOptions?: ExceptionOptions[];
}

Response to ‘setExceptionBreakpoints’ request. This is just an acknowledgement, so no body field is required.

interface SetExceptionBreakpointsResponse extends Response {
}

:leftwards_arrow_with_hook: Continue Request

The request starts the debuggee to run again.

interface ContinueRequest extends Request {
  command: 'continue';

  arguments: ContinueArguments;
}

Arguments for ‘continue’ request.

interface ContinueArguments {
  /**
   * Continue execution for the specified thread (if possible). If the backend cannot continue on a single thread but will continue on all threads, it should set the 'allThreadsContinued' attribute in the response to true.
   */
  threadId: number;
}

Response to ‘continue’ request.

interface ContinueResponse extends Response {
  body: {
    /**
     * If true, the 'continue' request has ignored the specified thread and continued all threads instead. If this attribute is missing a value of 'true' is assumed for backward compatibility.
     */
    allThreadsContinued?: boolean;
  };
}

:leftwards_arrow_with_hook: Next Request

The request starts the debuggee to run again for one step.

The debug adapter first sends the response and then a ‘stopped’ event (with reason ‘step’) after the step has completed.

interface NextRequest extends Request {
  command: 'next';

  arguments: NextArguments;
}

Arguments for ‘next’ request.

interface NextArguments {
  /**
   * Execute 'next' for this thread.
   */
  threadId: number;
}

Response to ‘next’ request. This is just an acknowledgement, so no body field is required.

interface NextResponse extends Response {
}

:leftwards_arrow_with_hook: StepIn Request

The request starts the debuggee to step into a function/method if possible.

If it cannot step into a target, ‘stepIn’ behaves like ‘next’.

The debug adapter first sends the response and then a ‘stopped’ event (with reason ‘step’) after the step has completed.

If there are multiple function/method calls (or other targets) on the source line,

the optional argument ‘targetId’ can be used to control into which target the ‘stepIn’ should occur.

The list of possible targets for a given source line can be retrieved via the ‘stepInTargets’ request.

interface StepInRequest extends Request {
  command: 'stepIn';

  arguments: StepInArguments;
}

Arguments for ‘stepIn’ request.

interface StepInArguments {
  /**
   * Execute 'stepIn' for this thread.
   */
  threadId: number;

  /**
   * Optional id of the target to step into.
   */
  targetId?: number;
}

Response to ‘stepIn’ request. This is just an acknowledgement, so no body field is required.

interface StepInResponse extends Response {
}

:leftwards_arrow_with_hook: StepOut Request

The request starts the debuggee to run again for one step.

The debug adapter first sends the response and then a ‘stopped’ event (with reason ‘step’) after the step has completed.

interface StepOutRequest extends Request {
  command: 'stepOut';

  arguments: StepOutArguments;
}

Arguments for ‘stepOut’ request.

interface StepOutArguments {
  /**
   * Execute 'stepOut' for this thread.
   */
  threadId: number;
}

Response to ‘stepOut’ request. This is just an acknowledgement, so no body field is required.

interface StepOutResponse extends Response {
}

:leftwards_arrow_with_hook: StepBack Request

The request starts the debuggee to run one step backwards.

The debug adapter first sends the response and then a ‘stopped’ event (with reason ‘step’) after the step has completed. Clients should only call this request if the capability ‘supportsStepBack’ is true.

interface StepBackRequest extends Request {
  command: 'stepBack';

  arguments: StepBackArguments;
}

Arguments for ‘stepBack’ request.

interface StepBackArguments {
  /**
   * Execute 'stepBack' for this thread.
   */
  threadId: number;
}

Response to ‘stepBack’ request. This is just an acknowledgement, so no body field is required.

interface StepBackResponse extends Response {
}

:leftwards_arrow_with_hook: ReverseContinue Request

The request starts the debuggee to run backward. Clients should only call this request if the capability ‘supportsStepBack’ is true.

interface ReverseContinueRequest extends Request {
  command: 'reverseContinue';

  arguments: ReverseContinueArguments;
}

Arguments for ‘reverseContinue’ request.

interface ReverseContinueArguments {
  /**
   * Execute 'reverseContinue' for this thread.
   */
  threadId: number;
}

Response to ‘reverseContinue’ request. This is just an acknowledgement, so no body field is required.

interface ReverseContinueResponse extends Response {
}

:leftwards_arrow_with_hook: RestartFrame Request

The request restarts execution of the specified stackframe.

The debug adapter first sends the response and then a ‘stopped’ event (with reason ‘restart’) after the restart has completed.

interface RestartFrameRequest extends Request {
  command: 'restartFrame';

  arguments: RestartFrameArguments;
}

Arguments for ‘restartFrame’ request.

interface RestartFrameArguments {
  /**
   * Restart this stackframe.
   */
  frameId: number;
}

Response to ‘restartFrame’ request. This is just an acknowledgement, so no body field is required.

interface RestartFrameResponse extends Response {
}

:leftwards_arrow_with_hook: Goto Request

The request sets the location where the debuggee will continue to run.

This makes it possible to skip the execution of code or to executed code again.

The code between the current location and the goto target is not executed but skipped.

The debug adapter first sends the response and then a ‘stopped’ event with reason ‘goto’.

interface GotoRequest extends Request {
  command: 'goto';

  arguments: GotoArguments;
}

Arguments for ‘goto’ request.

interface GotoArguments {
  /**
   * Set the goto target for this thread.
   */
  threadId: number;

  /**
   * The location where the debuggee will continue to run.
   */
  targetId: number;
}

Response to ‘goto’ request. This is just an acknowledgement, so no body field is required.

interface GotoResponse extends Response {
}

:leftwards_arrow_with_hook: Pause Request

The request suspenses the debuggee.

The debug adapter first sends the response and then a ‘stopped’ event (with reason ‘pause’) after the thread has been paused successfully.

interface PauseRequest extends Request {
  command: 'pause';

  arguments: PauseArguments;
}

Arguments for ‘pause’ request.

interface PauseArguments {
  /**
   * Pause execution for this thread.
   */
  threadId: number;
}

Response to ‘pause’ request. This is just an acknowledgement, so no body field is required.

interface PauseResponse extends Response {
}

:leftwards_arrow_with_hook: StackTrace Request

The request returns a stacktrace from the current execution state.

interface StackTraceRequest extends Request {
  command: 'stackTrace';

  arguments: StackTraceArguments;
}

Arguments for ‘stackTrace’ request.

interface StackTraceArguments {
  /**
   * Retrieve the stacktrace for this thread.
   */
  threadId: number;

  /**
   * The index of the first frame to return; if omitted frames start at 0.
   */
  startFrame?: number;

  /**
   * The maximum number of frames to return. If levels is not specified or 0, all frames are returned.
   */
  levels?: number;

  /**
   * Specifies details on how to format the stack frames.
   */
  format?: StackFrameFormat;
}

Response to ‘stackTrace’ request.

interface StackTraceResponse extends Response {
  body: {
    /**
     * The frames of the stackframe. If the array has length zero, there are no stackframes available.
     * This means that there is no location information available.
     */
    stackFrames: StackFrame[];

    /**
     * The total number of frames available.
     */
    totalFrames?: number;
  };
}

:leftwards_arrow_with_hook: Scopes Request

The request returns the variable scopes for a given stackframe ID.

interface ScopesRequest extends Request {
  command: 'scopes';

  arguments: ScopesArguments;
}

Arguments for ‘scopes’ request.

interface ScopesArguments {
  /**
   * Retrieve the scopes for this stackframe.
   */
  frameId: number;
}

Response to ‘scopes’ request.

interface ScopesResponse extends Response {
  body: {
    /**
     * The scopes of the stackframe. If the array has length zero, there are no scopes available.
     */
    scopes: Scope[];
  };
}

:leftwards_arrow_with_hook: Variables Request

Retrieves all child variables for the given variable reference.

An optional filter can be used to limit the fetched children to either named or indexed children.

interface VariablesRequest extends Request {
  command: 'variables';

  arguments: VariablesArguments;
}

Arguments for ‘variables’ request.

interface VariablesArguments {
  /**
   * The Variable reference.
   */
  variablesReference: number;

  /**
   * Optional filter to limit the child variables to either named or indexed. If ommited, both types are fetched.
   */
  filter?: 'indexed' | 'named';

  /**
   * The index of the first variable to return; if omitted children start at 0.
   */
  start?: number;

  /**
   * The number of variables to return. If count is missing or 0, all variables are returned.
   */
  count?: number;

  /**
   * Specifies details on how to format the Variable values.
   */
  format?: ValueFormat;
}

Response to ‘variables’ request.

interface VariablesResponse extends Response {
  body: {
    /**
     * All (or a range) of variables for the given variable reference.
     */
    variables: Variable[];
  };
}

:leftwards_arrow_with_hook: SetVariable Request

Set the variable with the given name in the variable container to a new value.

interface SetVariableRequest extends Request {
  command: 'setVariable';

  arguments: SetVariableArguments;
}

Arguments for ‘setVariable’ request.

interface SetVariableArguments {
  /**
   * The reference of the variable container.
   */
  variablesReference: number;

  /**
   * The name of the variable.
   */
  name: string;

  /**
   * The value of the variable.
   */
  value: string;

  /**
   * Specifies details on how to format the response value.
   */
  format?: ValueFormat;
}

Response to ‘setVariable’ request.

interface SetVariableResponse extends Response {
  body: {
    /**
     * The new value of the variable.
     */
    value: string;

    /**
     * The type of the new value. Typically shown in the UI when hovering over the value.
     */
    type?: string;

    /**
     * If variablesReference is > 0, the new value is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
     */
    variablesReference?: number;

    /**
     * The number of named child variables.
     * The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
     */
    namedVariables?: number;

    /**
     * The number of indexed child variables.
     * The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
     */
    indexedVariables?: number;
  };
}

:leftwards_arrow_with_hook: Source Request

The request retrieves the source code for a given source reference.

interface SourceRequest extends Request {
  command: 'source';

  arguments: SourceArguments;
}

Arguments for ‘source’ request.

interface SourceArguments {
  /**
   * Specifies the source content to load. Either source.path or source.sourceReference must be specified.
   */
  source?: Source;

  /**
   * The reference to the source. This is the same as source.sourceReference. This is provided for backward compatibility since old backends do not understand the 'source' attribute.
   */
  sourceReference: number;
}

Response to ‘source’ request.

interface SourceResponse extends Response {
  body: {
    /**
     * Content of the source reference.
     */
    content: string;

    /**
     * Optional content type (mime type) of the source.
     */
    mimeType?: string;
  };
}

:leftwards_arrow_with_hook: Threads Request

The request retrieves a list of all threads.

interface ThreadsRequest extends Request {
  command: 'threads';
}

Response to ‘threads’ request.

interface ThreadsResponse extends Response {
  body: {
    /**
     * All threads.
     */
    threads: Thread[];
  };
}

:leftwards_arrow_with_hook: TerminateThreads Request

The request terminates the threads with the given ids.

interface TerminateThreadsRequest extends Request {
  command: 'terminateThreads';

  arguments: TerminateThreadsArguments;
}

Arguments for ‘terminateThreads’ request.

interface TerminateThreadsArguments {
  /**
   * Ids of threads to be terminated.
   */
  threadIds?: number[];
}

Response to ‘terminateThreads’ request. This is just an acknowledgement, so no body field is required.

interface TerminateThreadsResponse extends Response {
}

:leftwards_arrow_with_hook: Modules Request

Modules can be retrieved from the debug adapter with the ModulesRequest which can either return all modules or a range of modules to support paging.

interface ModulesRequest extends Request {
  command: 'modules';

  arguments: ModulesArguments;
}

Arguments for ‘modules’ request.

interface ModulesArguments {
  /**
   * The index of the first module to return; if omitted modules start at 0.
   */
  startModule?: number;

  /**
   * The number of modules to return. If moduleCount is not specified or 0, all modules are returned.
   */
  moduleCount?: number;
}

Response to ‘modules’ request.

interface ModulesResponse extends Response {
  body: {
    /**
     * All modules or range of modules.
     */
    modules: Module[];

    /**
     * The total number of modules available.
     */
    totalModules?: number;
  };
}

:leftwards_arrow_with_hook: LoadedSources Request

Retrieves the set of all sources currently loaded by the debugged process.

interface LoadedSourcesRequest extends Request {
  command: 'loadedSources';

  arguments?: LoadedSourcesArguments;
}

Arguments for ‘loadedSources’ request.

interface LoadedSourcesArguments {
}

Response to ‘loadedSources’ request.

interface LoadedSourcesResponse extends Response {
  body: {
    /**
     * Set of loaded sources.
     */
    sources: Source[];
  };
}

:leftwards_arrow_with_hook: Evaluate Request

Evaluates the given expression in the context of the top most stack frame.

The expression has access to any variables and arguments that are in scope.

interface EvaluateRequest extends Request {
  command: 'evaluate';

  arguments: EvaluateArguments;
}

Arguments for ‘evaluate’ request.

interface EvaluateArguments {
  /**
   * The expression to evaluate.
   */
  expression: string;

  /**
   * Evaluate the expression in the scope of this stack frame. If not specified, the expression is evaluated in the global scope.
   */
  frameId?: number;

  /**
   * The context in which the evaluate request is run.
   * Values: 
   * 'watch': evaluate is run in a watch.
   * 'repl': evaluate is run from REPL console.
   * 'hover': evaluate is run from a data hover.
   * etc.
   */
  context?: string;

  /**
   * Specifies details on how to format the Evaluate result.
   */
  format?: ValueFormat;
}

Response to ‘evaluate’ request.

interface EvaluateResponse extends Response {
  body: {
    /**
     * The result of the evaluate request.
     */
    result: string;

    /**
     * The optional type of the evaluate result.
     */
    type?: string;

    /**
     * Properties of a evaluate result that can be used to determine how to render the result in the UI.
     */
    presentationHint?: VariablePresentationHint;

    /**
     * If variablesReference is > 0, the evaluate result is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
     */
    variablesReference: number;

    /**
     * The number of named child variables.
     * The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
     */
    namedVariables?: number;

    /**
     * The number of indexed child variables.
     * The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
     */
    indexedVariables?: number;
  };
}

:leftwards_arrow_with_hook: SetExpression Request

Evaluates the given ‘value’ expression and assigns it to the ‘expression’ which must be a modifiable l-value.

The expressions have access to any variables and arguments that are in scope of the specified frame.

interface SetExpressionRequest extends Request {
  command: 'setExpression';

  arguments: SetExpressionArguments;
}

Arguments for ‘setExpression’ request.

interface SetExpressionArguments {
  /**
   * The l-value expression to assign to.
   */
  expression: string;

  /**
   * The value expression to assign to the l-value expression.
   */
  value: string;

  /**
   * Evaluate the expressions in the scope of this stack frame. If not specified, the expressions are evaluated in the global scope.
   */
  frameId?: number;

  /**
   * Specifies how the resulting value should be formatted.
   */
  format?: ValueFormat;
}

Response to ‘setExpression’ request.

interface SetExpressionResponse extends Response {
  body: {
    /**
     * The new value of the expression.
     */
    value: string;

    /**
     * The optional type of the value.
     */
    type?: string;

    /**
     * Properties of a value that can be used to determine how to render the result in the UI.
     */
    presentationHint?: VariablePresentationHint;

    /**
     * If variablesReference is > 0, the value is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
     */
    variablesReference?: number;

    /**
     * The number of named child variables.
     * The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
     */
    namedVariables?: number;

    /**
     * The number of indexed child variables.
     * The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
     */
    indexedVariables?: number;
  };
}

:leftwards_arrow_with_hook: StepInTargets Request

This request retrieves the possible stepIn targets for the specified stack frame.

These targets can be used in the ‘stepIn’ request.

The StepInTargets may only be called if the ‘supportsStepInTargetsRequest’ capability exists and is true.

interface StepInTargetsRequest extends Request {
  command: 'stepInTargets';

  arguments: StepInTargetsArguments;
}

Arguments for ‘stepInTargets’ request.

interface StepInTargetsArguments {
  /**
   * The stack frame for which to retrieve the possible stepIn targets.
   */
  frameId: number;
}

Response to ‘stepInTargets’ request.

interface StepInTargetsResponse extends Response {
  body: {
    /**
     * The possible stepIn targets of the specified source location.
     */
    targets: StepInTarget[];
  };
}

:leftwards_arrow_with_hook: GotoTargets Request

This request retrieves the possible goto targets for the specified source location.

These targets can be used in the ‘goto’ request.

The GotoTargets request may only be called if the ‘supportsGotoTargetsRequest’ capability exists and is true.

interface GotoTargetsRequest extends Request {
  command: 'gotoTargets';

  arguments: GotoTargetsArguments;
}

Arguments for ‘gotoTargets’ request.

interface GotoTargetsArguments {
  /**
   * The source location for which the goto targets are determined.
   */
  source: Source;

  /**
   * The line location for which the goto targets are determined.
   */
  line: number;

  /**
   * An optional column location for which the goto targets are determined.
   */
  column?: number;
}

Response to ‘gotoTargets’ request.

interface GotoTargetsResponse extends Response {
  body: {
    /**
     * The possible goto targets of the specified location.
     */
    targets: GotoTarget[];
  };
}

:leftwards_arrow_with_hook: Completions Request

Returns a list of possible completions for a given caret position and text.

The CompletionsRequest may only be called if the ‘supportsCompletionsRequest’ capability exists and is true.

interface CompletionsRequest extends Request {
  command: 'completions';

  arguments: CompletionsArguments;
}

Arguments for ‘completions’ request.

interface CompletionsArguments {
  /**
   * Returns completions in the scope of this stack frame. If not specified, the completions are returned for the global scope.
   */
  frameId?: number;

  /**
   * One or more source lines. Typically this is the text a user has typed into the debug console before he asked for completion.
   */
  text: string;

  /**
   * The character position for which to determine the completion proposals.
   */
  column: number;

  /**
   * An optional line for which to determine the completion proposals. If missing the first line of the text is assumed.
   */
  line?: number;
}

Response to ‘completions’ request.

interface CompletionsResponse extends Response {
  body: {
    /**
     * The possible completions for .
     */
    targets: CompletionItem[];
  };
}

:leftwards_arrow_with_hook: ExceptionInfo Request

Retrieves the details of the exception that caused this event to be raised.

interface ExceptionInfoRequest extends Request {
  command: 'exceptionInfo';

  arguments: ExceptionInfoArguments;
}

Arguments for ‘exceptionInfo’ request.

interface ExceptionInfoArguments {
  /**
   * Thread for which exception information should be retrieved.
   */
  threadId: number;
}

Response to ‘exceptionInfo’ request.

interface ExceptionInfoResponse extends Response {
  body: {
    /**
     * ID of the exception that was thrown.
     */
    exceptionId: string;

    /**
     * Descriptive text for the exception provided by the debug adapter.
     */
    description?: string;

    /**
     * Mode that caused the exception notification to be raised.
     */
    breakMode: ExceptionBreakMode;

    /**
     * Detailed information about the exception.
     */
    details?: ExceptionDetails;
  };
}

Types

Capabilities

Information about the capabilities of a debug adapter.

interface Capabilities {
  /**
   * The debug adapter supports the 'configurationDone' request.
   */
  supportsConfigurationDoneRequest?: boolean;

  /**
   * The debug adapter supports function breakpoints.
   */
  supportsFunctionBreakpoints?: boolean;

  /**
   * The debug adapter supports conditional breakpoints.
   */
  supportsConditionalBreakpoints?: boolean;

  /**
   * The debug adapter supports breakpoints that break execution after a specified number of hits.
   */
  supportsHitConditionalBreakpoints?: boolean;

  /**
   * The debug adapter supports a (side effect free) evaluate request for data hovers.
   */
  supportsEvaluateForHovers?: boolean;

  /**
   * Available filters or options for the setExceptionBreakpoints request.
   */
  exceptionBreakpointFilters?: ExceptionBreakpointsFilter[];

  /**
   * The debug adapter supports stepping back via the 'stepBack' and 'reverseContinue' requests.
   */
  supportsStepBack?: boolean;

  /**
   * The debug adapter supports setting a variable to a value.
   */
  supportsSetVariable?: boolean;

  /**
   * The debug adapter supports restarting a frame.
   */
  supportsRestartFrame?: boolean;

  /**
   * The debug adapter supports the 'gotoTargets' request.
   */
  supportsGotoTargetsRequest?: boolean;

  /**
   * The debug adapter supports the 'stepInTargets' request.
   */
  supportsStepInTargetsRequest?: boolean;

  /**
   * The debug adapter supports the 'completions' request.
   */
  supportsCompletionsRequest?: boolean;

  /**
   * The debug adapter supports the 'modules' request.
   */
  supportsModulesRequest?: boolean;

  /**
   * The set of additional module information exposed by the debug adapter.
   */
  additionalModuleColumns?: ColumnDescriptor[];

  /**
   * Checksum algorithms supported by the debug adapter.
   */
  supportedChecksumAlgorithms?: ChecksumAlgorithm[];

  /**
   * 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 RestartRequest.
   */
  supportsRestartRequest?: boolean;

  /**
   * The debug adapter supports 'exceptionOptions' on the setExceptionBreakpoints request.
   */
  supportsExceptionOptions?: boolean;

  /**
   * The debug adapter supports a 'format' attribute on the stackTraceRequest, variablesRequest, and evaluateRequest.
   */
  supportsValueFormattingOptions?: boolean;

  /**
   * The debug adapter supports the 'exceptionInfo' request.
   */
  supportsExceptionInfoRequest?: boolean;

  /**
   * The debug adapter supports the 'terminateDebuggee' attribute on the 'disconnect' request.
   */
  supportTerminateDebuggee?: boolean;

  /**
   * 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.
   */
  supportsDelayedStackTraceLoading?: boolean;

  /**
   * The debug adapter supports the 'loadedSources' request.
   */
  supportsLoadedSourcesRequest?: boolean;

  /**
   * The debug adapter supports logpoints by interpreting the 'logMessage' attribute of the SourceBreakpoint.
   */
  supportsLogPoints?: boolean;

  /**
   * The debug adapter supports the 'terminateThreads' request.
   */
  supportsTerminateThreadsRequest?: boolean;

  /**
   * The debug adapter supports the 'setExpression' request.
   */
  supportsSetExpression?: boolean;

  /**
   * The debug adapter supports the 'terminate' request.
   */
  supportsTerminateRequest?: boolean;
}

ExceptionBreakpointsFilter

An ExceptionBreakpointsFilter is shown in the UI as an option for configuring how exceptions are dealt with.

interface ExceptionBreakpointsFilter {
  /**
   * The internal ID of the filter. This value is passed to the setExceptionBreakpoints request.
   */
  filter: string;

  /**
   * The name of the filter. This will be shown in the UI.
   */
  label: string;

  /**
   * Initial value of the filter. If not specified a value 'false' is assumed.
   */
  default?: boolean;
}

Message

A structured message object. Used to return errors from requests.

interface Message {
  /**
   * Unique identifier for the message.
   */
  id: number;

  /**
   * 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.
   */
  format: string;

  /**
   * An object used as a dictionary for looking up the variables in the format string.
   */
  variables?: { [key: string]: string; };

  /**
   * If true send to telemetry.
   */
  sendTelemetry?: boolean;

  /**
   * If true show user.
   */
  showUser?: boolean;

  /**
   * An optional url where additional information about this message can be found.
   */
  url?: string;

  /**
   * An optional label that is presented to the user as the UI for opening the url.
   */
  urlLabel?: string;
}

Module

A Module object represents a row in the modules view.

Two attributes are mandatory: an id identifies a module in the modules view and is used in a ModuleEvent for identifying a module for adding, updating or deleting.

The name is used to minimally render the module in the UI.

Additional attributes can be added to the module. They will show up in the module View if they have a corresponding ColumnDescriptor.

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.

interface Module {
  /**
   * Unique identifier for the module.
   */
  id: number | string;

  /**
   * A name of the module.
   */
  name: string;

  /**
   * optional but recommended attributes.
   * always try to use these first before introducing additional attributes.
   * 
   * 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.
   */
  path?: string;

  /**
   * True if the module is optimized.
   */
  isOptimized?: boolean;

  /**
   * True if the module is considered 'user code' by a debugger that supports 'Just My Code'.
   */
  isUserCode?: boolean;

  /**
   * Version of Module.
   */
  version?: string;

  /**
   * User understandable description of if symbols were found for the module (ex: 'Symbols Loaded', 'Symbols not found', etc.
   */
  symbolStatus?: string;

  /**
   * Logical full path to the symbol file. The exact definition is implementation defined.
   */
  symbolFilePath?: string;

  /**
   * Module created or modified.
   */
  dateTimeStamp?: string;

  /**
   * Address range covered by this module.
   */
  addressRange?: string;
}

ColumnDescriptor

A ColumnDescriptor specifies what module attribute to show in a column of the ModulesView, how to format it, and what the column’s label should be.

It is only used if the underlying UI actually supports this level of customization.

interface ColumnDescriptor {
  /**
   * Name of the attribute rendered in this column.
   */
  attributeName: string;

  /**
   * Header UI label of column.
   */
  label: string;

  /**
   * Format to use for the rendered values in this column. TBD how the format strings looks like.
   */
  format?: string;

  /**
   * Datatype of values in this column.  Defaults to 'string' if not specified.
   */
  type?: 'string' | 'number' | 'boolean' | 'unixTimestampUTC';

  /**
   * Width of this column in characters (hint only).
   */
  width?: number;
}

ModulesViewDescriptor

The ModulesViewDescriptor is the container for all declarative configuration options of a ModuleView.

For now it only specifies the columns to be shown in the modules view.

interface ModulesViewDescriptor {
  columns: ColumnDescriptor[];
}

Thread

A Thread

interface Thread {
  /**
   * Unique identifier for the thread.
   */
  id: number;

  /**
   * A name of the thread.
   */
  name: string;
}

Source

A Source is a descriptor for source code. It is returned from the debug adapter as part of a StackFrame and it is used by clients when specifying breakpoints.

interface Source {
  /**
   * 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.
   */
  name?: string;

  /**
   * 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).
   */
  path?: string;

  /**
   * If sourceReference > 0 the contents of the source must be retrieved through the SourceRequest (even if a path is specified). A sourceReference is only valid for a session, so it must not be used to persist a source.
   */
  sourceReference?: number;

  /**
   * An optional 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.
   */
  presentationHint?: 'normal' | 'emphasize' | 'deemphasize';

  /**
   * The (optional) origin of this source: possible values 'internal module', 'inlined content from source map', etc.
   */
  origin?: string;

  /**
   * An optional list of sources that are related to this source. These may be the source that generated this source.
   */
  sources?: Source[];

  /**
   * Optional 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.
   */
  adapterData?: any;

  /**
   * The checksums associated with this file.
   */
  checksums?: Checksum[];
}

StackFrame

A Stackframe contains the source location.

interface StackFrame {
  /**
   * 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 'scopesRequest' or to restart the execution of a stackframe.
   */
  id: number;

  /**
   * The name of the stack frame, typically a method name.
   */
  name: string;

  /**
   * The optional source of the frame.
   */
  source?: Source;

  /**
   * The line within the file of the frame. If source is null or doesn't exist, line is 0 and must be ignored.
   */
  line: number;

  /**
   * The column within the line. If source is null or doesn't exist, column is 0 and must be ignored.
   */
  column: number;

  /**
   * An optional end line of the range covered by the stack frame.
   */
  endLine?: number;

  /**
   * An optional end column of the range covered by the stack frame.
   */
  endColumn?: number;

  /**
   * The module associated with this frame, if any.
   */
  moduleId?: number | string;

  /**
   * An optional 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.
   */
  presentationHint?: 'normal' | 'label' | 'subtle';
}

Scope

A Scope is a named container for variables. Optionally a scope can map to a source or a range within a source.

interface Scope {
  /**
   * Name of the scope such as 'Arguments', 'Locals'.
   */
  name: string;

  /**
   * The variables of this scope can be retrieved by passing the value of variablesReference to the VariablesRequest.
   */
  variablesReference: number;

  /**
   * The number of named variables in this scope.
   * The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
   */
  namedVariables?: number;

  /**
   * The number of indexed variables in this scope.
   * The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
   */
  indexedVariables?: number;

  /**
   * If true, the number of variables in this scope is large or expensive to retrieve.
   */
  expensive: boolean;

  /**
   * Optional source for this scope.
   */
  source?: Source;

  /**
   * Optional start line of the range covered by this scope.
   */
  line?: number;

  /**
   * Optional start column of the range covered by this scope.
   */
  column?: number;

  /**
   * Optional end line of the range covered by this scope.
   */
  endLine?: number;

  /**
   * Optional end column of the range covered by this scope.
   */
  endColumn?: number;
}

Variable

A Variable is a name/value pair.

Optionally a variable can have a ‘type’ that is shown if space permits or when hovering over the variable’s name.

An optional ‘kind’ 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.

If the value is structured (has children), a handle is provided to retrieve the children with the VariablesRequest.

If the number of named or indexed children is large, the numbers should be returned via the optional ‘namedVariables’ and ‘indexedVariables’ attributes.

The client can use this optional information to present the children in a paged UI and fetch them in chunks.

interface Variable {
  /**
   * The variable's name.
   */
  name: string;

  /**
   * The variable's value. This can be a multi-line text, e.g. for a function the body of a function.
   */
  value: string;

  /**
   * The type of the variable's value. Typically shown in the UI when hovering over the value.
   */
  type?: string;

  /**
   * Properties of a variable that can be used to determine how to render the variable in the UI.
   */
  presentationHint?: VariablePresentationHint;

  /**
   * Optional evaluatable name of this variable which can be passed to the 'EvaluateRequest' to fetch the variable's value.
   */
  evaluateName?: string;

  /**
   * If variablesReference is > 0, the variable is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
   */
  variablesReference: number;

  /**
   * The number of named child variables.
   * The client can use this optional information to present the children in a paged UI and fetch them in chunks.
   */
  namedVariables?: number;

  /**
   * The number of indexed child variables.
   * The client can use this optional information to present the children in a paged UI and fetch them in chunks.
   */
  indexedVariables?: number;
}

VariablePresentationHint

Optional properties of a variable that can be used to determine how to render the variable in the UI.

interface VariablePresentationHint {
  /**
   * 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.
   * etc.
   */
  kind?: string;

  /**
   * 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.
   * 'canHaveObjectId': Indicates that the object has an Object ID associated with it.
   * 'hasSideEffects': Indicates that the evaluation had side effects.
   * etc.
   */
  attributes?: string[];

  /**
   * Visibility of variable. Before introducing additional values, try to use the listed values.
   * Values: 'public', 'private', 'protected', 'internal', 'final', etc.
   */
  visibility?: string;
}

SourceBreakpoint

Properties of a breakpoint or logpoint passed to the setBreakpoints request.

interface SourceBreakpoint {
  /**
   * The source line of the breakpoint or logpoint.
   */
  line: number;

  /**
   * An optional source column of the breakpoint.
   */
  column?: number;

  /**
   * An optional expression for conditional breakpoints.
   */
  condition?: string;

  /**
   * An optional expression that controls how many hits of the breakpoint are ignored. The backend is expected to interpret the expression as needed.
   */
  hitCondition?: string;

  /**
   * If this attribute exists and is non-empty, the backend must not 'break' (stop) but log the message instead. Expressions within {} are interpolated.
   */
  logMessage?: string;
}

FunctionBreakpoint

Properties of a breakpoint passed to the setFunctionBreakpoints request.

interface FunctionBreakpoint {
  /**
   * The name of the function.
   */
  name: string;

  /**
   * An optional expression for conditional breakpoints.
   */
  condition?: string;

  /**
   * An optional expression that controls how many hits of the breakpoint are ignored. The backend is expected to interpret the expression as needed.
   */
  hitCondition?: string;
}

Breakpoint

Information about a Breakpoint created in setBreakpoints or setFunctionBreakpoints.

interface Breakpoint {
  /**
   * An optional identifier for the breakpoint. It is needed if breakpoint events are used to update or remove breakpoints.
   */
  id?: number;

  /**
   * If true breakpoint could be set (but not necessarily at the desired location).
   */
  verified: boolean;

  /**
   * An optional 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.
   */
  message?: string;

  /**
   * The source where the breakpoint is located.
   */
  source?: Source;

  /**
   * The start line of the actual range covered by the breakpoint.
   */
  line?: number;

  /**
   * An optional start column of the actual range covered by the breakpoint.
   */
  column?: number;

  /**
   * An optional end line of the actual range covered by the breakpoint.
   */
  endLine?: number;

  /**
   * An optional end column of the actual range covered by the breakpoint. If no end line is given, then the end column is assumed to be in the start line.
   */
  endColumn?: number;
}

StepInTarget

A StepInTarget can be used in the ‘stepIn’ request and determines into which single target the stepIn request should step.

interface StepInTarget {
  /**
   * Unique identifier for a stepIn target.
   */
  id: number;

  /**
   * The name of the stepIn target (shown in the UI).
   */
  label: string;
}

GotoTarget

A GotoTarget describes a code location that can be used as a target in the ‘goto’ request.

The possible goto targets can be determined via the ‘gotoTargets’ request.

interface GotoTarget {
  /**
   * Unique identifier for a goto target. This is used in the goto request.
   */
  id: number;

  /**
   * The name of the goto target (shown in the UI).
   */
  label: string;

  /**
   * The line of the goto target.
   */
  line: number;

  /**
   * An optional column of the goto target.
   */
  column?: number;

  /**
   * An optional end line of the range covered by the goto target.
   */
  endLine?: number;

  /**
   * An optional end column of the range covered by the goto target.
   */
  endColumn?: number;
}

CompletionItem

CompletionItems are the suggestions returned from the CompletionsRequest.

interface CompletionItem {
  /**
   * The label of this completion item. By default this is also the text that is inserted when selecting this completion.
   */
  label: string;

  /**
   * If text is not falsy then it is inserted instead of the label.
   */
  text?: string;

  /**
   * The item's type. Typically the client uses this information to render the item in the UI with an icon.
   */
  type?: CompletionItemType;

  /**
   * This value determines the location (in the CompletionsRequest's 'text' attribute) where the completion text is added.
   * If missing the text is added at the location specified by the CompletionsRequest's 'column' attribute.
   */
  start?: number;

  /**
   * This value determines how many characters are overwritten by the completion text.
   * If missing the value 0 is assumed which results in the completion text being inserted.
   */
  length?: number;
}

CompletionItemType

Some predefined types for the CompletionItem. Please note that not all clients have specific icons for all of them.

type CompletionItemType = 'method' | 'function' | 'constructor' | 'field' | 'variable' | 'class' | 'interface' | 'module' | 'property' | 'unit' | 'value' | 'enum' | 'keyword' | 'snippet' | 'text' | 'color' | 'file' | 'reference' | 'customcolor';

ChecksumAlgorithm

Names of checksum algorithms that may be supported by a debug adapter.

type ChecksumAlgorithm = 'MD5' | 'SHA1' | 'SHA256' | 'timestamp';

Checksum

The checksum of an item calculated by the specified algorithm.

interface Checksum {
  /**
   * The algorithm used to calculate this checksum.
   */
  algorithm: ChecksumAlgorithm;

  /**
   * Value of the checksum.
   */
  checksum: string;
}

ValueFormat

Provides formatting information for a value.

interface ValueFormat {
  /**
   * Display the value in hex.
   */
  hex?: boolean;
}

StackFrameFormat

Provides formatting information for a stack frame.

interface StackFrameFormat extends ValueFormat {
  /**
   * Displays parameters for the stack frame.
   */
  parameters?: boolean;

  /**
   * Displays the types of parameters for the stack frame.
   */
  parameterTypes?: boolean;

  /**
   * Displays the names of parameters for the stack frame.
   */
  parameterNames?: boolean;

  /**
   * Displays the values of parameters for the stack frame.
   */
  parameterValues?: boolean;

  /**
   * Displays the line number of the stack frame.
   */
  line?: boolean;

  /**
   * Displays the module of the stack frame.
   */
  module?: boolean;

  /**
   * Includes all stack frames, including those the debug adapter might otherwise hide.
   */
  includeAll?: boolean;
}

ExceptionOptions

An ExceptionOptions assigns configuration options to a set of exceptions.

interface ExceptionOptions {
  /**
   * 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.
   */
  path?: ExceptionPathSegment[];

  /**
   * Condition when a thrown exception should result in a break.
   */
  breakMode: ExceptionBreakMode;
}

ExceptionBreakMode

This enumeration defines all possible conditions when a thrown exception should result in a break.

never: never breaks,

always: always breaks,

unhandled: breaks when excpetion unhandled,

userUnhandled: breaks if the exception is not handled by user code.

type ExceptionBreakMode = 'never' | 'always' | 'unhandled' | 'userUnhandled';

ExceptionPathSegment

An ExceptionPathSegment represents a segment in a path that is used to match leafs or nodes in a tree of exceptions. If a segment consists of more than one name, it matches the names provided if ‘negate’ is false or missing or it matches anything except the names provided if ‘negate’ is true.

interface ExceptionPathSegment {
  /**
   * If false or missing this segment matches the names provided, otherwise it matches anything except the names provided.
   */
  negate?: boolean;

  /**
   * Depending on the value of 'negate' the names that should match or not match.
   */
  names: string[];
}

ExceptionDetails

Detailed information about an exception that has occurred.

interface ExceptionDetails {
  /**
   * Message contained in the exception.
   */
  message?: string;

  /**
   * Short type name of the exception object.
   */
  typeName?: string;

  /**
   * Fully-qualified type name of the exception object.
   */
  fullTypeName?: string;

  /**
   * Optional expression that can be evaluated in the current scope to obtain the exception object.
   */
  evaluateName?: string;

  /**
   * Stack trace at the time the exception was thrown.
   */
  stackTrace?: string;

  /**
   * Details of the exception contained by this exception, if any.
   */
  innerException?: ExceptionDetails[];
}