Interface IBreakpoint

Single breakpoint in an editor.

interface IBreakpoint {
    column?: number;
    endColumn?: number;
    endLine?: number;
    id?: number;
    instructionReference?: string;
    line?: number;
    message?: string;
    offset?: number;
    source?: Source;
    verified: boolean;
}

Hierarchy

  • Breakpoint
    • IBreakpoint

Properties

column? endColumn? endLine? id? instructionReference? line? message? offset? source? verified

Properties

Optional column

column?: number

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.

Optional endColumn

endColumn?: number

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.

Optional endLine

endLine?: number

The end line of the actual range covered by the breakpoint.

Optional id

id?: number

The identifier for the breakpoint. It is needed if breakpoint events are used to update or remove breakpoints.

Optional instructionReference

instructionReference?: string

A memory reference to where the breakpoint is set.

Optional line

line?: number

The start line of the actual range covered by the breakpoint.

Optional message

message?: string

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.

Optional offset

offset?: number

The offset from the instruction reference. This can be negative.

Optional source

source?: Source

The source where the breakpoint is located.

verified

verified: boolean

If true, the breakpoint could be set (but not necessarily at the desired location).

Settings

Member Visibility

Theme

On This Page

columnendColumnendLineidinstructionReferencelinemessageoffsetsourceverified