Module cdp::debugger

Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.

Debugger

Commands

• Debugger.enable

  Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.

• Debugger.disable

  Disables debugger for given page.

• Debugger.setBreakpointsActive

  Activates / deactivates all breakpoints on the page.

• Debugger.setSkipAllPauses

  Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).

• Debugger.setBreakpointByUrl

  Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in locations property. Further matching script parsing will result in subsequent breakpointResolved events issued. This logical breakpoint will survive page reloads.

• Debugger.setBreakpoint

  Sets JavaScript breakpoint at a given location.

• Debugger.removeBreakpoint

  Removes JavaScript breakpoint.

• Debugger.getPossibleBreakpoints Experimental

  Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.

• Debugger.continueToLocation

  Continues execution until specific location is reached.

• Debugger.stepOver

  Steps over the statement.

• Debugger.stepInto

  Steps into the function call.

• Debugger.stepOut

  Steps out of the function call.

• Debugger.pause

  Stops on the next JavaScript statement.

• Debugger.scheduleStepIntoAsync Experimental

  Steps into next scheduled async task if any is scheduled before next pause. Returns success when async task is actually scheduled, returns error if no task were scheduled or another scheduleStepIntoAsync was called.

• Debugger.resume

  Resumes JavaScript execution.

• Debugger.searchInContent Experimental

  Searches for given string in script content.

• Debugger.setScriptSource

  Edits JavaScript source live.

• Debugger.restartFrame

  Restarts particular call frame from the beginning.

• Debugger.getScriptSource

  Returns source for the script with given id.

• Debugger.setPauseOnExceptions

  Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is none.

• Debugger.evaluateOnCallFrame

  Evaluates expression on a given call frame.

• Debugger.setVariableValue

  Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.

• Debugger.setAsyncCallStackDepth

  Enables or disables async call stacks tracking.

• Debugger.setBlackboxPatterns Experimental

  Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.

• Debugger.setBlackboxedRanges Experimental

  Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted.

Events

• Debugger.scriptParsed

  Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.

• Debugger.scriptFailedToParse

  Fired when virtual machine fails to parse the script.

• Debugger.breakpointResolved

  Fired when breakpoint is resolved to an actual script and location.

• Debugger.paused

  Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

• Debugger.resumed

  Fired when the virtual machine resumed execution.

Types

• BreakpointId

  Breakpoint identifier.

• CallFrameId

  Call frame identifier.

• Location

  Location in the source code.

• ScriptPosition Experimental

  Location in the source code.

• CallFrame

  JavaScript call frame. Array of call frames form the call stack.

• Scope

  Scope description.

• SearchMatch Experimental

  Search match for resource.

• BreakLocation Experimental

Structs

BreakLocation	[Experimental]
BreakpointResolvedEvent	Fired when breakpoint is resolved to an actual script and location.
CallFrame	JavaScript call frame. Array of call frames form the call stack.
ContinueToLocationCommand	Continues execution until specific location is reached.
ContinueToLocationResponse	Continues execution until specific location is reached.
DisableCommand	Disables debugger for given page.
DisableResponse	Disables debugger for given page.
EnableCommand	Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.
EnableResponse	Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.
EvaluateOnCallFrameCommand	Evaluates expression on a given call frame.
EvaluateOnCallFrameResponse	Evaluates expression on a given call frame.
GetPossibleBreakpointsCommand	[Experimental] Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.
GetPossibleBreakpointsResponse	[Experimental] Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.
GetScriptSourceCommand	Returns source for the script with given id.
GetScriptSourceResponse	Returns source for the script with given id.
Location	Location in the source code.
PauseCommand	Stops on the next JavaScript statement.
PauseResponse	Stops on the next JavaScript statement.
PausedEvent	Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.
RemoveBreakpointCommand	Removes JavaScript breakpoint.
RemoveBreakpointResponse	Removes JavaScript breakpoint.
RestartFrameCommand	Restarts particular call frame from the beginning.
RestartFrameResponse	Restarts particular call frame from the beginning.
ResumeCommand	Resumes JavaScript execution.
ResumeResponse	Resumes JavaScript execution.
ResumedEvent	Fired when the virtual machine resumed execution.
ScheduleStepIntoAsyncCommand	[Experimental] Steps into next scheduled async task if any is scheduled before next pause. Returns success when async task is actually scheduled, returns error if no task were scheduled or another scheduleStepIntoAsync was called.
ScheduleStepIntoAsyncResponse	[Experimental] Steps into next scheduled async task if any is scheduled before next pause. Returns success when async task is actually scheduled, returns error if no task were scheduled or another scheduleStepIntoAsync was called.
Scope	Scope description.
ScriptFailedToParseEvent	Fired when virtual machine fails to parse the script.
ScriptParsedEvent	Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.
ScriptPosition	[Experimental] Location in the source code.
SearchInContentCommand	[Experimental] Searches for given string in script content.
SearchInContentResponse	[Experimental] Searches for given string in script content.
SearchMatch	[Experimental] Search match for resource.
SetAsyncCallStackDepthCommand	Enables or disables async call stacks tracking.
SetAsyncCallStackDepthResponse	Enables or disables async call stacks tracking.
SetBlackboxPatternsCommand	[Experimental] Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.
SetBlackboxPatternsResponse	[Experimental] Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.
SetBlackboxedRangesCommand	[Experimental] Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted.
SetBlackboxedRangesResponse	[Experimental] Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted.
SetBreakpointByUrlCommand	Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in locations property. Further matching script parsing will result in subsequent breakpointResolved events issued. This logical breakpoint will survive page reloads.
SetBreakpointByUrlResponse	Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in locations property. Further matching script parsing will result in subsequent breakpointResolved events issued. This logical breakpoint will survive page reloads.
SetBreakpointCommand	Sets JavaScript breakpoint at a given location.
SetBreakpointResponse	Sets JavaScript breakpoint at a given location.
SetBreakpointsActiveCommand	Activates / deactivates all breakpoints on the page.
SetBreakpointsActiveResponse	Activates / deactivates all breakpoints on the page.
SetPauseOnExceptionsCommand	Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is none.
SetPauseOnExceptionsResponse	Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is none.
SetScriptSourceCommand	Edits JavaScript source live.
SetScriptSourceResponse	Edits JavaScript source live.
SetSkipAllPausesCommand	Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).
SetSkipAllPausesResponse	Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).
SetVariableValueCommand	Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.
SetVariableValueResponse	Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.
StepIntoCommand	Steps into the function call.
StepIntoResponse	Steps into the function call.
StepOutCommand	Steps out of the function call.
StepOutResponse	Steps out of the function call.
StepOverCommand	Steps over the statement.
StepOverResponse	Steps over the statement.

Enums

BreakLocationType	[Experimental]
ContinueToLocationCommandTargetCallFrames	Used in the type of cdp::debugger::ContinueToLocationCommand::target_call_frames.
PausedEventReason	Used in the type of cdp::debugger::PausedEvent::reason.
ScopeType	Used in the type of cdp::debugger::Scope::ty.
SetPauseOnExceptionsCommandState	Used in the type of cdp::debugger::SetPauseOnExceptionsCommand::state.

Type Definitions

BreakpointId	Breakpoint identifier.
CallFrameId	Call frame identifier.