Methods

Chrome DevTools

Runtime.awaitPromise #

Add handler to promise with given promise object id.

Parameters

promiseObjectId
RemoteObjectId

Identifier of the promise.

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.

Return object

result
RemoteObject

Promise result. Will contain rejected value if promise was rejected.

exceptionDetails
Optional
ExceptionDetails

Exception details if stack strace is available.


HermesHermes (Legacy)Chrome DevTools

Runtime.callFunctionOn #

Calls function with given declaration on the given object. Object group of the result is inherited from the target object.

In V8, @cdp Runtime.evaluate and @cdp Runtime.callFunctionOn populate the result field with the exception value, and some code paths in Chrome DevTools depend on this. See https://github.com/facebookexperimental/rn-chrome-devtools-frontend/blob/35aa264a622e853bb28b4c83a7b5cc3b2a9747bc/front_end/core/sdk/RemoteObject.ts#L574-L592

Handles Runtime.callFunctionOn request @cdp Runtime.callFunctionOn Allowed even if domain is not enabled.

Parameters

objectId
RemoteObjectId

Identifier of the object to call function on.

functionDeclaration
string

Declaration of the function to call.

arguments
Optional
array[ CallArgument ]

Call arguments. All call arguments must belong to the same JavaScript world as the target object.

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 which should be sent by value.

generatePreview
Optional
boolean

Whether preview should be generated for the result.

Experimental
userGesture
Optional
boolean

Whether execution should be treated as initiated by user in the UI.

Experimental
awaitPromise
Optional
boolean

Whether execution should wait for promise to be resolved. If the result of evaluation is not a Promise, it's considered to be an error.

Return object

result
RemoteObject

Call result.

exceptionDetails
Optional
ExceptionDetails

Exception details.


HermesHermes (Legacy)Chrome DevTools

Runtime.compileScript #

Compiles expression.

Handles Runtime.compileScript request @cdp Runtime.compileScript Not allowed if domain is not enabled.

Parameters

expression
string

Expression to compile.

sourceURL
string

Source url to be set for the script.

persistScript
boolean

Specifies whether the compiled script should be persisted.

executionContextId
Optional
ExecutionContextId

Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.

Return object

scriptId
Optional
ScriptId

Id of the script.

exceptionDetails
Optional
ExceptionDetails

Exception details.


HermesHermes (Legacy)React NativeChrome DevTools

Runtime.disable #

Disables reporting of execution contexts creation.

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


HermesChrome DevTools

Runtime.discardConsoleEntries #

Discards collected exceptions and console API calls.


HermesHermes (Legacy)React NativeChrome DevTools

Runtime.enable #

Enables reporting of execution contexts creation by means of executionContextCreated event. When the reporting gets enabled the event will be sent immediately for each existing execution context.

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


HermesHermes (Legacy)Chrome DevTools

Runtime.evaluate #

Evaluates expression on global object.

In V8, @cdp Runtime.evaluate and @cdp Runtime.callFunctionOn populate the result field with the exception value, and some code paths in Chrome DevTools depend on this. See https://github.com/facebookexperimental/rn-chrome-devtools-frontend/blob/35aa264a622e853bb28b4c83a7b5cc3b2a9747bc/front_end/core/sdk/RemoteObject.ts#L574-L592

Handles Runtime.evaluate request @cdp Runtime.evaluate Allowed even if domain is not enabled.

Parameters

expression
string

Expression to evaluate.

objectGroup
Optional
string

Symbolic group name that can be used to release multiple objects.

includeCommandLineAPI
Optional
boolean

Determines whether Command Line API should be available during the evaluation.

silent
Optional
boolean

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

contextId
Optional
ExecutionContextId

Specifies in which execution context to perform evaluation. If the parameter is omitted the evaluation will be performed in the context of the inspected page.

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
userGesture
Optional
boolean

Whether execution should be treated as initiated by user in the UI.

Experimental
awaitPromise
Optional
boolean

Whether execution should wait for promise to be resolved. If the result of evaluation is not a Promise, it's considered to be an error.

Return object

result
RemoteObject

Evaluation result.

exceptionDetails
Optional
ExceptionDetails

Exception details.


HermesHermes (Legacy)Chrome DevTools

Runtime.getProperties #

Returns properties of a given object. Object group of the result is inherited from the target object.

Handles Runtime.getProperties request @cdp Runtime.getProperties Allowed even if domain is not enabled.

Parameters

objectId
RemoteObjectId

Identifier of the object to return properties for.

ownProperties
Optional
boolean

If true, returns properties belonging only to the element itself, not to its prototype chain.

accessorPropertiesOnly
Optional
boolean

If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.

Experimental
generatePreview
Optional
boolean

Whether preview should be generated for the results.

Experimental

Return object

result
array[ PropertyDescriptor ]

Object properties.

internalProperties
Optional
array[ InternalPropertyDescriptor ]

Internal object properties (only of the element itself).

exceptionDetails
Optional
ExceptionDetails

Exception details.


Chrome DevTools

Runtime.releaseObject #

Releases remote object with given id.

Parameters

objectId
RemoteObjectId

Identifier of the object to release.


Chrome DevTools

Runtime.releaseObjectGroup #

Releases all remote objects that belong to a given group.

Parameters

objectGroup
string

Symbolic object group name.


Hermes (Legacy)Chrome DevTools

Runtime.runIfWaitingForDebugger #

Tells inspected instance to run if it was waiting for debugger to attach.


Chrome DevTools

Runtime.runScript #

Runs script with given id in a given context.

Parameters

scriptId
ScriptId

Id of the script to run.

executionContextId
Optional
ExecutionContextId

Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.

objectGroup
Optional
string

Symbolic group name that can be used to release multiple objects.

silent
Optional
boolean

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

includeCommandLineAPI
Optional
boolean

Determines whether Command Line API should be available during the evaluation.

returnByValue
Optional
boolean

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

generatePreview
Optional
boolean

Whether preview should be generated for the result.

awaitPromise
Optional
boolean

Whether execution should wait for promise to be resolved. If the result of evaluation is not a Promise, it's considered to be an error.

Return object

result
RemoteObject

Run result.

exceptionDetails
Optional
ExceptionDetails

Exception details.

Events

HermesHermes (Legacy)React NativeChrome DevTools

Runtime.consoleAPICalled #

Issued when console API was called.

We use the @cdp Runtime.consoleAPICalled context parameter to mark synthetic messages generated by the backend, i.e. not originating in a real console.* API call.

Parameters

type
string

Type of the call.

Allowed values: log, debug, info, error, warning, dir, dirxml, table, trace, clear, startGroup, startGroupCollapsed, endGroup, assert, profile, profileEnd

args
array[ RemoteObject ]

Call arguments.

executionContextId
ExecutionContextId

Identifier of the context where the call was made.

timestamp
Timestamp

Call timestamp.

stackTrace
Optional
StackTrace

Stack trace captured when the call was made.


Chrome DevTools

Runtime.exceptionRevoked #

Issued when unhandled exception was revoked.

Parameters

reason
string

Reason describing why exception was revoked.

exceptionId
integer

The id of revoked exception, as reported in exceptionUnhandled.


Chrome DevTools

Runtime.exceptionThrown #

Issued when exception was thrown and unhandled.

Parameters

timestamp
Timestamp

Timestamp of the exception.

exceptionDetails

Hermes (Legacy)React NativeChrome DevTools

Runtime.executionContextCreated #

Issued when new execution context is created.

Parameters

context
ExecutionContextDescription

A newly created execution contex.


React NativeChrome DevTools

Runtime.executionContextDestroyed #

Issued when execution context is destroyed.

Parameters

executionContextId
ExecutionContextId

Id of the destroyed context


React NativeChrome DevTools

Runtime.executionContextsCleared #

Issued when all executionContexts were cleared in browser


Chrome DevTools

Runtime.inspectRequested #

Issued when object should be inspected (for example, as a result of inspect() command line API call).

Parameters

hints
object

Types

HermesHermes (Legacy)Chrome DevTools

Runtime.CallArgument #

Represents function call argument. Either remote object id objectId, primitive value, unserializable primitive value or neither of (for undefined) them should be specified.

Type: object

Properties

value
Optional
any

Primitive value.

unserializableValue
Optional
UnserializableValue

Primitive value which can not be JSON-stringified.

objectId
Optional
RemoteObjectId

Remote object handle.


HermesHermes (Legacy)Chrome DevTools

Runtime.CallFrame #

Stack entry for runtime errors and assertions.

Type: object

Properties

functionName
string

JavaScript function name.

scriptId
ScriptId

JavaScript script id.

url
string

JavaScript script name or url.

lineNumber
integer

JavaScript script line number (0-based).

columnNumber
integer

JavaScript script column number (0-based).


HermesHermes (Legacy)Chrome DevTools

Runtime.ExceptionDetails #

Detailed information about exception (or error) that was thrown during script compilation or execution.

Type: object

Properties

exceptionId
integer

Exception id.

text
string

Exception text, which should be used together with exception object when available.

lineNumber
integer

Line number of the exception location (0-based).

columnNumber
integer

Column number of the exception location (0-based).

scriptId
Optional
ScriptId

Script ID of the exception location.

url
Optional
string

URL of the exception location, to be used when the script was not reported.

stackTrace
Optional
StackTrace

JavaScript stack trace if available.

exception
Optional
RemoteObject

Exception object if available.

executionContextId
Optional
ExecutionContextId

Identifier of the context where exception happened.


HermesHermes (Legacy)Chrome DevTools

Runtime.ExecutionContextDescription #

Description of an isolated world.

Type: object

Properties

id
ExecutionContextId

Unique id of the execution context. It can be used to specify in which execution context script evaluation should be performed.

origin
string

Execution context origin.

name
string

Human readable name describing given context.

auxData
Optional
object

Embedder-specific auxiliary data.


HermesHermes (Legacy)Chrome DevTools

Runtime.ExecutionContextId #

Id of an execution context.

Type: integer


HermesHermes (Legacy)Chrome DevTools

Runtime.InternalPropertyDescriptor #

Object internal property descriptor. This property isn't normally visible in JavaScript code.

Type: object

Properties

name
string

Conventional property name.

value
Optional
RemoteObject

The value associated with the property.


HermesHermes (Legacy)Chrome DevTools

Runtime.PropertyDescriptor #

Object property descriptor.

Type: object

Properties

name
string

Property name or symbol description.

value
Optional
RemoteObject

The value associated with the property.

writable
Optional
boolean

True if the value associated with the property may be changed (data descriptors only).

get
Optional
RemoteObject

A function which serves as a getter for the property, or undefined if there is no getter (accessor descriptors only).

set
Optional
RemoteObject

A function which serves as a setter for the property, or undefined if there is no setter (accessor descriptors only).

configurable
boolean

True if the type of this property descriptor may be changed and if the property may be deleted from the corresponding object.

enumerable
boolean

True if this property shows up during enumeration of the properties on the corresponding object.

wasThrown
Optional
boolean

True if the result was thrown during the evaluation.

isOwn
Optional
boolean

True if the property is owned for the object.

symbol
Optional
RemoteObject

Property symbol object, if the property is of the symbol type.


HermesHermes (Legacy)Chrome DevTools

Runtime.RemoteObject #

Mirror object referencing original JavaScript object.

Type: object

Runtime.RemoteObject's description property is a string, but in the case of functions, V8 populates it with the result of toString [1] and Chrome DevTools uses a series of regexes [2] to extract structured information about the function. [1] https://source.chromium.org/chromium/chromium/src/+/main:v8/src/debug/debug-interface.cc;l=138-174;drc=42debe0b0e6bf90175dd0d121eb0e7dc11a6d29c [2] https://github.com/facebookexperimental/rn-chrome-devtools-frontend/blob/9a23d4c7c4c2d1a3d9e913af38d6965f474c4284/front_end/ui/legacy/components/object_ui/ObjectPropertiesSection.ts#L311-L391

Properties

type
string

Object type.

Allowed values: object, function, undefined, string, number, boolean, symbol

subtype
Optional
string

Object subtype hint. Specified for object type values only.

Allowed values: array, null, node, regexp, date, map, set, iterator, generator, error, proxy, promise, typedarray

className
Optional
string

Object class (constructor) name. Specified for object type values only.

value
Optional
any

Remote object value in case of primitive values or JSON values (if it was requested).

unserializableValue
Optional
UnserializableValue

Primitive value which can not be JSON-stringified does not have value, but gets this property.

description
Optional
string

String representation of the object.

objectId
Optional
RemoteObjectId

Unique object identifier (for non-primitive values).

preview
Optional
ObjectPreview

Preview containing abbreviated property values. Specified for object type values only.

Experimental
customPreview
Optional
CustomPreviewExperimental

HermesHermes (Legacy)Chrome DevTools

Runtime.RemoteObjectId #

Unique object identifier.

Type: string


HermesHermes (Legacy)Chrome DevTools

Runtime.ScriptId #

Unique script identifier.

Type: string


HermesHermes (Legacy)Chrome DevTools

Runtime.StackTrace #

Call frames for assertions or error messages.

Type: object

Properties

description
Optional
string

String label of this stack trace. For async traces this may be a name of the function that initiated the async call.

callFrames
array[ CallFrame ]

JavaScript function name.

parent
Optional
StackTrace

Asynchronous JavaScript stack trace that preceded this stack, if available.


HermesHermes (Legacy)Chrome DevTools

Runtime.Timestamp #

Number of milliseconds since epoch.

Type: number


HermesHermes (Legacy)Chrome DevTools

Runtime.UnserializableValue #

Primitive value which cannot be JSON-stringified.

Type: string

Allowed values: Infinity, NaN, -Infinity, -0