Interface IDebugger

Readonly config

Readonly eventMessage

Readonly isStarted

Readonly model

Readonly pauseOnExceptionChanged

session

Readonly sessionChanged

clearBreakpoints

• clearBreakpoints(): Promise<void>

• Removes all the breakpoints from the current notebook or console

  Returns Promise<void>

continue

• continue(): Promise<void>

• Continues the execution of the current thread.

  Returns Promise<void>

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>

displayDefinedVariables

• displayDefinedVariables(): Promise<void>

• Requests all the defined variables and display them in the table view.

  Returns Promise<void>

displayModules

• displayModules(): Promise<void>

• Requests all the loaded modules and display them.

  Returns Promise<void>

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

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

getCodeId

• getCodeId(code): string

• Computes an id based on the given code.

  Parameters

  • code: string

  Returns string

getDebuggerState

• getDebuggerState(): State

• Get the debugger state

  Returns State

  Debugger state

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>

hasStoppedThreads

• hasStoppedThreads(): boolean

• Whether there exist a thread in stopped state.

  Returns boolean

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

inspectVariable

• inspectVariable(variablesReference): Promise<Variable[]>

• Request variables for a given variable reference.

  Parameters

  • variablesReference: number

    The variable reference to request.

  Returns Promise<Variable[]>

isAvailable

• isAvailable(connection): Promise<boolean>

• Request whether debugging is available for the given session connection.

  Parameters

  • connection: ISessionConnection

    The session connection.

  Returns Promise<boolean>

next

• next(): Promise<void>

• Makes the current thread run again for one step.

  Returns Promise<void>

pause

• pause(): Promise<void>

• Makes the current thread pause if possible.

  Returns Promise<void>

pauseOnExceptions

• pauseOnExceptions(exceptionFilter): Promise<void>

• Send the pauseOnExceptions' filters to the debugger.

  Parameters

  • exceptionFilter: string[]

  Returns Promise<void>

pauseOnExceptionsFilter

• pauseOnExceptionsFilter(exceptionFilter): Promise<void>

• Add a filter to pauseOnExceptionsFilter.

  Parameters

  • exceptionFilter: string

    filter name.

  Returns Promise<void>

pauseOnExceptionsIsValid

• pauseOnExceptionsIsValid(): boolean

• Used to determine if kernel has pause on exception capabilities

  Returns boolean

restart

• restart(): Promise<void>

• Restart the debugger. Precondition: isStarted

  Returns Promise<void>

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

restoreState

• restoreState(autoStart): Promise<void>

• Restore the state of a debug session.

  Parameters

  • autoStart: boolean

    when true, starts the debugger if it has not been started yet.

  Returns Promise<void>

start

• start(): Promise<void>

• Starts a debugger. Precondition: !isStarted

  Returns Promise<void>

stepIn

• stepIn(): Promise<void>

• Makes the current thread step in a function / method if possible.

  Returns Promise<void>

stepOut

• stepOut(): Promise<void>

• Makes the current thread step out a function / method if possible.

  Returns Promise<void>

stop

• stop(): Promise<void>

• Stops the debugger. Precondition: isStarted

  Returns Promise<void>

updateBreakpoints

• updateBreakpoints(code, breakpoints, path?): Promise<void>

• Update all breakpoints of a cell 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>