Interface IStackFrame

The type for a stack frame

interface IStackFrame {
    canRestart?: boolean;
    column: number;
    endColumn?: number;
    endLine?: number;
    id: number;
    instructionPointerReference?: string;
    line: number;
    moduleId?: string | number;
    name: string;
    presentationHint?: "normal" | "label" | "subtle";
    source?: Source;
}

Hierarchy

  • StackFrame
    • IStackFrame

Properties

canRestart? column endColumn? endLine? id instructionPointerReference? line moduleId? name presentationHint? source?

Properties

Optional canRestart

canRestart?: boolean

Indicates whether this frame can be restarted with the restart request. Clients should only use this if the debug adapter supports the restart request and the corresponding capability supportsRestartRequest is true. If a debug adapter has this capability, then canRestart defaults to true if the property is absent.

column

column: number

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.

Optional endColumn

endColumn?: number

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.

Optional endLine

endLine?: number

The end line of the range covered by the stack frame.

id

id: number

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.

Optional instructionPointerReference

instructionPointerReference?: string

A memory reference for the current instruction pointer in this frame.

line

line: number

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.

Optional moduleId

moduleId?: string | number

The module associated with this frame, if any.

name

name: string

The name of the stack frame, typically a method name.

Optional presentationHint

presentationHint?: "normal" | "label" | "subtle"

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.

Optional source

source?: Source

The source of the frame.

Settings

Member Visibility

Theme

On This Page

canRestartcolumnendColumnendLineidinstructionPointerReferencelinemoduleIdnamepresentationHintsource