Class Service

The main IDebugger implementation.

Hierarchy

DebuggerService
- Service

Constructors

constructor

new Service(options): Service
Instantiate a new DebuggerService.
Parameters
- options: IOptions
  The instantiation options for a DebuggerService.
Returns Service
Inherited from DebuggerService.constructor
- Defined in packages/debugger/src/service.ts:33

Accessors

config

get config(): IDebugger.IConfig
Get debugger config.

Returns IDebugger.IConfig
Inherited from DebuggerService.config
- Defined in packages/debugger/src/service.ts:57

eventMessage

get eventMessage(): ISignal<IDebugger, Event>
Signal emitted for debug event messages.

Returns ISignal<IDebugger, Event>
Inherited from DebuggerService.eventMessage
- Defined in packages/debugger/src/service.ts:50

isDisposed

get isDisposed(): boolean
Whether the debug service is disposed.

Returns boolean
Inherited from DebuggerService.isDisposed
- Defined in packages/debugger/src/service.ts:64

isStarted

get isStarted(): boolean
Whether the current debugger is started.

Returns boolean
Inherited from DebuggerService.isStarted
- Defined in packages/debugger/src/service.ts:71

model

get model(): IService
Returns the debugger service's model.

Returns IService
Inherited from DebuggerService.model
- Defined in packages/debugger/src/service.ts:85

pauseOnExceptionChanged

get pauseOnExceptionChanged(): Signal<IDebugger, void>
A signal emitted when the pause on exception filter changes.

Returns Signal<IDebugger, void>
Inherited from DebuggerService.pauseOnExceptionChanged
- Defined in packages/debugger/src/service.ts:78

session

get session(): null | ISession
Returns the current debug session.

Returns null | ISession
Inherited from DebuggerService.session
- Defined in packages/debugger/src/service.ts:92
set session(session): void
Sets the current debug session to the given parameter.
Parameters
- session: null | ISession
  the new debugger session.
Returns void
Inherited from DebuggerService.session
- Defined in packages/debugger/src/service.ts:101

sessionChanged

get sessionChanged(): ISignal<IDebugger, null | ISession>
Signal emitted upon session changed.

Returns ISignal<IDebugger, null | ISession>
Inherited from DebuggerService.sessionChanged
- Defined in packages/debugger/src/service.ts:128

Methods

clearBreakpoints

clearBreakpoints(): Promise<void>
Clear all the breakpoints for the current session.

Returns Promise<void>
Inherited from DebuggerService.clearBreakpoints
- Defined in packages/debugger/src/service.ts:193

continue

continue(): Promise<void>
Continues the execution of the current thread.

Returns Promise<void>
Inherited from DebuggerService.continue
- Defined in packages/debugger/src/service.ts:209

copyToGlobals

copyToGlobals(name): Promise<void>
Request to set a variable in the global scope.
Parameters
- name: string
  The name of the variable.
Returns Promise<void>
Inherited from DebuggerService.copyToGlobals
- Defined in packages/debugger/src/service.ts:335

displayDefinedVariables

displayDefinedVariables(): Promise<void>
Requests all the defined variables and display them in the table view.

Returns Promise<void>
Inherited from DebuggerService.displayDefinedVariables
- Defined in packages/debugger/src/service.ts:369

displayModules

displayModules(): Promise<void>
Returns Promise<void>
Inherited from DebuggerService.displayModules
- Defined in packages/debugger/src/service.ts:385

dispose

dispose(): void
Dispose the debug service.

Returns void
Inherited from DebuggerService.dispose
- Defined in packages/debugger/src/service.ts:135

evaluate

evaluate(expression): Promise<null | {
    indexedVariables?: number;
    memoryReference?: string;
    namedVariables?: number;
    presentationHint?: VariablePresentationHint;
    result: string;
    type?: string;
    variablesReference: number;
}>
Evaluate an expression.
Parameters
- expression: string
  The expression to evaluate as a string.
Returns Promise<null | {
    indexedVariables?: number;
    memoryReference?: string;
    namedVariables?: number;
    presentationHint?: VariablePresentationHint;
    result: string;
    type?: string;
    variablesReference: number;
}>
Inherited from DebuggerService.evaluate
- Defined in packages/debugger/src/service.ts:246

getCodeId

getCodeId(code): string
Computes an id based on the given code.
Parameters
- code: string
  The source code.
Returns string
Inherited from DebuggerService.getCodeId
- Defined in packages/debugger/src/service.ts:148

getDebuggerState

getDebuggerState(): State
Get the debugger state

Returns State
Debugger state
Inherited from DebuggerService.getDebuggerState
- Defined in packages/debugger/src/service.ts:658

getSource

getSource(source): Promise<Source>
Retrieve the content of a source file.
Parameters
- source: Source
  The source object containing the path to the file.
Returns Promise<Source>
Inherited from DebuggerService.getSource
- Defined in packages/debugger/src/service.ts:230

hasStoppedThreads

hasStoppedThreads(): boolean
Whether there exists a thread in stopped state.

Returns boolean
Inherited from DebuggerService.hasStoppedThreads
- Defined in packages/debugger/src/service.ts:162

inspectRichVariable

inspectRichVariable(variableName, frameId?): Promise<IRichVariable>
Request rich representation of a variable.
Parameters
- variableName: string
  The variable name to request
- Optional frameId: number
  The current frame id in which to request the variable
Returns Promise<IRichVariable>
The mime renderer data model
Inherited from DebuggerService.inspectRichVariable
- Defined in packages/debugger/src/service.ts:291

inspectVariable

inspectVariable(variablesReference): Promise<Variable[]>
Request variables for a given variable reference.
Parameters
- variablesReference: number
  The variable reference to request.
Returns Promise<Variable[]>
Inherited from DebuggerService.inspectVariable
- Defined in packages/debugger/src/service.ts:314

isAvailable

isAvailable(connection): Promise<boolean>
Request whether debugging is available for the session connection.
Parameters
- connection: ISessionConnection
  The session connection.
Returns Promise<boolean>
Inherited from DebuggerService.isAvailable
- Defined in packages/debugger/src/service.ts:171

next(): Promise<void>
Makes the current thread run again for one step.

Returns Promise<void>
Inherited from DebuggerService.next
- Defined in packages/debugger/src/service.ts:271

pause

pause(): Promise<void>
Makes the current thread pause if possible.

Returns Promise<void>
Inherited from DebuggerService.pause
- Defined in packages/debugger/src/service.ts:486

pauseOnExceptions

pauseOnExceptions(exceptionFilters): Promise<void>
Enable or disable pausing on exceptions.
Parameters
- exceptionFilters: string[]
  The filters to use for the current debugging session.
Returns Promise<void>
Inherited from DebuggerService.pauseOnExceptions
- Defined in packages/debugger/src/service.ts:634

pauseOnExceptionsFilter

pauseOnExceptionsFilter(exceptionFilter): Promise<void>
Add or remove a filter from the current used filters.
Parameters
- exceptionFilter: string
  The filter to add or remove from current filters.
Returns Promise<void>
Inherited from DebuggerService.pauseOnExceptionsFilter
- Defined in packages/debugger/src/service.ts:615

pauseOnExceptionsIsValid

pauseOnExceptionsIsValid(): boolean
Determines if pausing on exceptions is supported by the kernel

Returns boolean
Inherited from DebuggerService.pauseOnExceptionsIsValid
- Defined in packages/debugger/src/service.ts:601

restart

restart(): Promise<void>
Restart the debugger.

Returns Promise<void>
Inherited from DebuggerService.restart
- Defined in packages/debugger/src/service.ts:404

restoreDebuggerState

restoreDebuggerState(state): Promise<boolean>
Restore the debugger state
Parameters
- state: State
  Debugger state
Returns Promise<boolean>
Whether the state has been restored successfully or not
Inherited from DebuggerService.restoreDebuggerState
- Defined in packages/debugger/src/service.ts:682

restoreState

restoreState(autoStart): Promise<void>
Restore the state of a debug session.
Parameters
- autoStart: boolean
  If true, starts the debugger if it has not been started.
Returns Promise<void>
Inherited from DebuggerService.restoreState
- Defined in packages/debugger/src/service.ts:416

start

start(): Promise<void>
Starts a debugger. Precondition: !isStarted

Returns Promise<void>
Inherited from DebuggerService.start
- Defined in packages/debugger/src/service.ts:476

stepIn

stepIn(): Promise<void>
Makes the current thread step in a function / method if possible.

Returns Promise<void>
Inherited from DebuggerService.stepIn
- Defined in packages/debugger/src/service.ts:502

stepOut

stepOut(): Promise<void>
Makes the current thread step out a function / method if possible.

Returns Promise<void>
Inherited from DebuggerService.stepOut
- Defined in packages/debugger/src/service.ts:518

stop

stop(): Promise<void>
Stops the debugger. Precondition: isStarted

Returns Promise<void>
Inherited from DebuggerService.stop
- Defined in packages/debugger/src/service.ts:535

updateBreakpoints

updateBreakpoints(code, breakpoints, path?): Promise<void>
Update all breakpoints at once.
Parameters
- code: string
  The code in the cell where the breakpoints are set.
- breakpoints: IBreakpoint[]
  The list of breakpoints to set.
- Optional path: string
  Optional path to the file where to set the breakpoints.
Returns Promise<void>
Inherited from DebuggerService.updateBreakpoints
- Defined in packages/debugger/src/service.ts:552

Class Service

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Service

Accessors

config

Returns IDebugger.IConfig

eventMessage

Returns ISignal<IDebugger, Event>

isDisposed

Returns boolean

isStarted

Returns boolean

model

Returns IService

pauseOnExceptionChanged

Returns Signal<IDebugger, void>

session

Returns null | ISession

Parameters

Returns void

sessionChanged

Returns ISignal<IDebugger, null | ISession>

Methods

clearBreakpoints

Returns Promise<void>

continue

Returns Promise<void>

copyToGlobals

Parameters

Returns Promise<void>

displayDefinedVariables

Returns Promise<void>

displayModules

Returns Promise<void>

dispose

Returns void

evaluate

Parameters

Returns Promise<null | { indexedVariables?: number; memoryReference?: string; namedVariables?: number; presentationHint?: VariablePresentationHint; result: string; type?: string; variablesReference: number; }>

getCodeId

Parameters

Returns string

getDebuggerState

Returns State

getSource

Parameters

Returns Promise<Source>

hasStoppedThreads

Returns boolean

inspectRichVariable

Parameters

Returns Promise<IRichVariable>

inspectVariable

Parameters

Returns Promise<Variable[]>

isAvailable

Parameters

Returns Promise<boolean>

next

Returns Promise<void>

pause

Returns Promise<void>

pauseOnExceptions

Parameters

Returns Promise<void>

pauseOnExceptionsFilter

Parameters

Returns Promise<void>

pauseOnExceptionsIsValid

Returns boolean

restart

Returns Promise<void>

restoreDebuggerState

Returns Promise<null | {
indexedVariables?: number;
memoryReference?: string;
namedVariables?: number;
presentationHint?: VariablePresentationHint;
result: string;
type?: string;
variablesReference: number;
}>