Interface ISession

A visual debugger session.

interface ISession {
    capabilities: undefined | Capabilities;
    connection: null | Session.ISessionConnection;
    currentExceptionFilters: string[];
    disposed: ISignal<IDebugger.ISession, void>;
    eventMessage: ISignal<IDebugger.ISession, Event>;
    exceptionBreakpointFilters: undefined | ExceptionBreakpointsFilter[];
    exceptionPaths: string[];
    isDisposed: boolean;
    isStarted: boolean;
    dispose(): void;
    isPausingOnException(filter?: string): boolean;
    restoreState(): Promise<IDebugInfoResponse>;
    sendRequest<K extends keyof IDebugger.ISession.Request>(
        command: K,
        args: IDebugger.ISession.Request[K],
    ): Promise<Response[K]>;
    start(): Promise<void>;
    stop(): Promise<void>;
}

Hierarchy

Properties

capabilities connection currentExceptionFilters disposed eventMessage exceptionBreakpointFilters exceptionPaths isDisposed isStarted

Methods

dispose isPausingOnException restoreState sendRequest start stop

Properties

Readonlycapabilities

capabilities: undefined | Capabilities

Returns the initialize response.

connection

connection: null | Session.ISessionConnection

The API session connection to connect to a debugger.

currentExceptionFilters

currentExceptionFilters: string[]

Get current exception filter.

Readonlydisposed

disposed: ISignal<IDebugger.ISession, void>

A signal emitted when the object is disposed.

ReadonlyeventMessage

eventMessage: ISignal<IDebugger.ISession, Event>

Signal emitted for debug event messages.

exceptionBreakpointFilters

exceptionBreakpointFilters: undefined | ExceptionBreakpointsFilter[]

Get exception filters and default values.

exceptionPaths

exceptionPaths: string[]

Whether the debug session is pausing on exceptions.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

ReadonlyisStarted

isStarted: boolean

Whether the debug session is started.

Methods

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

isPausingOnException

  • isPausingOnException(filter?: string): boolean

  • Whether the debugger is pausing on exception.

    Parameters

    • Optionalfilter: string

      Specify a filter

    Returns boolean

restoreState

sendRequest

start

stop

Settings

Member Visibility

On This Page

Properties
Methods