React Native CDP Status

facebook/hermes/…/DebuggerDomainAgent.h:104

Location to continue to.

Debugger.disable #

Disables debugger for given page.

Handles Debugger.disable request @cdp Debugger.disable If domain is already disabled, will return success.

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.

Handles Debugger.enable request @cdp Debugger.enable If domain is already enabled, will return success.

facebook/hermes/…/DebuggerDomainAgent.h:101

Debugger.evaluateOnCallFrame #

Evaluates expression on a given call frame.

In V8, @cdp Debugger.evaluateOnCallFrame populates the result field with the exception value.

facebook/hermes/…/DebuggerDomainAgent.cpp:303

Parameters

callFrameId

Call frame identifier to evaluate on.

expression

string

Expression to evaluate.

objectGroup
Optional

string

String object group name to put result into (allows rapid releasing resulting object handles using releaseObjectGroup).

includeCommandLineAPI
Optional

boolean

Specifies whether command line API should be available to the evaluated expression, defaults to false.

silent
Optional

boolean

In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.

returnByValue
Optional

boolean

Whether the result is expected to be a JSON object that should be sent by value.

generatePreview
Optional

boolean

Whether preview should be generated for the result.

Experimental

Return object

result

Object wrapper for the evaluation result.

exceptionDetails
Optional

Runtime.ExceptionDetails

Exception details.

Debugger.getScriptSource #

Returns source for the script with given id.

Parameters

scriptId

Id of the script to get source for.

Return object

scriptSource

string

Script source.

Debugger.pause #

Stops on the next JavaScript statement.

Debugger.removeBreakpoint #

Removes JavaScript breakpoint.

Parameters

breakpointId

Debugger.restartFrame #

Restarts particular call frame from the beginning.

Parameters

callFrameId

Call frame identifier to evaluate on.

Return object

callFrames

array[ CallFrame ]

New stack trace.

asyncStackTrace
Optional

Runtime.StackTrace

Async stack trace, if any.

Debugger.resume #

Resumes JavaScript execution.

Debugger.setAsyncCallStackDepth #

Enables or disables async call stacks tracking.

Parameters

maxDepth

integer

Maximum depth of async call stacks. Setting to 0 will effectively disable collecting async call stacks (default).

Debugger.setBreakpoint #

Sets JavaScript breakpoint at a given location.

Parameters

location

Location to set breakpoint in.

condition
Optional

string

Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.

Return object

breakpointId

Id of the created breakpoint for further reference.

actualLocation

Location this breakpoint resolved into.

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.

Parameters

lineNumber

integer

Line number to set breakpoint at.

url
Optional

string

URL of the resources to set breakpoint on.

urlRegex
Optional

string

Regex pattern for the URLs of the resources to set breakpoints on. Either url or urlRegex must be specified.

columnNumber
Optional

integer

Offset in the line to set breakpoint at.

condition
Optional

string

Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.

Return object

breakpointId

facebook/hermes/…/DebuggerDomainAgent.h:135

Id of the created breakpoint for further reference.

locations

array[ Location ]

List of the locations this breakpoint resolved into upon addition.

Debugger.setBreakpointsActive #

Activates / deactivates all breakpoints on the page.

Handles Debugger.setBreakpointsActive @cdp Debugger.setBreakpointsActive Allowed even if domain is not enabled.

Parameters

active

boolean

New value for breakpoints active state.

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.

Parameters

state

string

Pause on exceptions mode.

Allowed values: none, uncaught, all

Debugger.setScriptSource #

Edits JavaScript source live.

Parameters

scriptId

Id of the script to edit.

scriptSource

string

New content of the script.

dryRun
Optional

boolean

If true the change will not actually be applied. Dry run may be used to get result description without actually modifying the code.

Return object

callFrames
Optional

array[ CallFrame ]

New stack trace in case editing has happened while VM was stopped.

stackChanged
Optional

boolean

Whether current call stack was modified after applying the changes.

asyncStackTrace
Optional

Runtime.StackTrace

Async stack trace, if any.

exceptionDetails
Optional

Runtime.ExceptionDetails

Exception details if any.

Debugger.setSkipAllPauses #

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

Parameters

skip

boolean

New value for skip pauses state.

Debugger.setVariableValue #

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

Parameters

scopeNumber

integer

0-based number of scope as was listed in scope chain. Only 'local', 'closure' and 'catch' scope types are allowed. Other scopes could be manipulated manually.

variableName

string

Variable name.

newValue

Runtime.CallArgument

New variable value.

callFrameId

Id of callframe that holds variable.

Debugger.stepInto #

Steps into the function call.

Debugger.stepOut #

Steps out of the function call.

Debugger.stepOver #

Steps over the statement.

Events

Debugger.breakpointResolved #

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

Parameters

breakpointId

Breakpoint unique identifier.

location

facebook/hermes/…/DebuggerDomainAgent.cpp:453

Actual breakpoint location.

Debugger.paused #

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

Although the documentation lists the "data" field as optional for the @cdp Debugger.paused event: https://chromedevtools.github.io/devtools-protocol/tot/Debugger/#event-paused it is accessed unconditionally by the front-end when the pause reason is "exception". "data" is passed in as "auxData" via: https://github.com/facebookexperimental/rn-chrome-devtools-frontend/blob/9a23d4c7c4c2d1a3d9e913af38d6965f474c4284/front_end/core/sdk/DebuggerModel.ts#L994 and "auxData" stored in a DebuggerPausedDetails instance: https://github.com/facebookexperimental/rn-chrome-devtools-frontend/blob/9a23d4c7c4c2d1a3d9e913af38d6965f474c4284/front_end/core/sdk/DebuggerModel.ts#L642 which then has its fields accessed in: https://github.com/facebookexperimental/rn-chrome-devtools-frontend/blob/main/front_end/panels/sources/DebuggerPausedMessage.ts#L225 If the "data" ("auxData") object is absent, accessing its fields will throw, breaking the display of pause information. Thus, we always populate "data" with an object. The "data" field has no schema in the protocol metadata that we use to generate message structures, so we need to manually construct a JSON object here. The structure expected by the front-end (specifically, the "description" field) can be inferred from the field access at the URL above. The front-end does gracefully handle missing fields on the "data" object, so we can consider the "description" field optional.

Parameters

callFrames

array[ CallFrame ]

Call stack the virtual machine stopped on.

reason

string

Pause reason.

Allowed values: XHR, DOM, EventListener, exception, assert, debugCommand, promiseRejection, other

data
Optional

object

Object containing break-specific auxiliary properties.

hitBreakpoints
Optional

array[ string ]

Hit breakpoints IDs

asyncStackTrace
Optional

Runtime.StackTrace

Async stack trace, if any.

Debugger.resumed #

Fired when the virtual machine resumed execution.

Debugger.scriptFailedToParse #

Fired when virtual machine fails to parse the script.

Parameters

scriptId

Runtime.ExecutionContextId

Identifier of the script parsed.

url

string

URL or name of the script parsed (if any).

startLine

integer

Line offset of the script within the resource with given URL (for script tags).

startColumn

integer

Column offset of the script within the resource with given URL.

endLine

integer

Last line of the script.

endColumn

integer

Length of the last line of the script.

executionContextId

Specifies script creation context.

hash

string

Content hash of the script.

executionContextAuxData
Optional

object

Embedder-specific auxiliary data.

sourceMapURL
Optional

string

URL of source map associated with script (if any).

hasSourceURL
Optional

boolean

True, if this script has sourceURL.

Experimental

Debugger.scriptParsed #

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

Parameters

scriptId

Runtime.ExecutionContextId

Identifier of the script parsed.

url

string

URL or name of the script parsed (if any).

startLine

integer

Line offset of the script within the resource with given URL (for script tags).

startColumn

integer

Column offset of the script within the resource with given URL.

endLine

integer

Last line of the script.

endColumn

integer

Length of the last line of the script.

executionContextId

Specifies script creation context.

hash

string

Content hash of the script.

executionContextAuxData
Optional

object

Embedder-specific auxiliary data.

isLiveEdit
Optional

boolean

True, if this script is generated as a result of the live edit operation.

Experimental

sourceMapURL
Optional

string

URL of source map associated with script (if any).

hasSourceURL
Optional

boolean

True, if this script has sourceURL.

Experimental

Types

Debugger.BreakpointId #

Breakpoint identifier.

Type: string

Debugger.CallFrame #

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

Type: object

Properties

callFrameId

Call frame identifier. This identifier is only valid while the virtual machine is paused.

functionName

string

Name of the JavaScript function called on this call frame.

functionLocation
Optional

Location in the source code.

Experimental

location

Location in the source code.

scopeChain

array[ Scope ]

Scope chain for this call frame.

this

this object for this call frame.

returnValue
Optional

The value being returned, if the function is at return point.

Debugger.CallFrameId #

Call frame identifier.

Type: string

Debugger.Location #

Location in the source code.

Type: object

Properties

scriptId

Script identifier as reported in the Debugger.scriptParsed.

lineNumber

integer

Line number in the script (0-based).

columnNumber
Optional

integer

Column number in the script (0-based).

Debugger.Scope #

Scope description.

Type: object

Properties

type

string

Scope type.

Allowed values: global, local, with, closure, catch, block, script

object

Object representing the scope. For global and with scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties.

name
Optional

string

startLocation
Optional

Location in the source code where scope starts

endLocation
Optional