Runtime Domain
Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects. Evaluation results are returned as mirror object that expose object type, string representation and unique identifier that can be used for further object reference. Original objects are maintained in memory unless they are either explicitly released or are released along with the other objects in their object group.
Methods
- Runtime.callFunctionOn
- Runtime.compileScript
- Runtime.disable
- Runtime.discardConsoleEntries
- Runtime.enable
- Runtime.evaluate
- Runtime.getProperties
- Runtime.globalLexicalScopeNames
- Runtime.getHeapUsage Experimental
Events
Types
Methods
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
functionDeclaration
string
Declaration of the function to call.
objectId
Optional
Identifier of the object to call function on. Either objectId or executionContextId should be specified.
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.
Can be overriden by serializationOptions
.
generatePreview
Optional
boolean
Whether preview should be generated for the result.
userGesture
Optional
boolean
Whether execution should be treated as initiated by user in the UI.
awaitPromise
Optional
boolean
Whether execution should await
for resulting value and return once awaited promise is
resolved.
executionContextId
Optional
Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified.
objectGroup
Optional
string
Symbolic group name that can be used to release multiple objects. If objectGroup is not specified and objectId is, objectGroup will be inherited from object.
throwOnSideEffect
Optional
boolean
Whether to throw an exception if side effect cannot be ruled out during evaluation.
uniqueContextId
Optional
string
An alternative way to specify the execution context to call function on.
Compared to contextId that may be reused across processes, this is guaranteed to be
system-unique, so it can be used to prevent accidental function call
in context different than intended (e.g. as a result of navigation across process
boundaries).
This is mutually exclusive with executionContextId
.
serializationOptions
Optional
Specifies the result serialization. If provided, overrides
generatePreview
and returnByValue
.
Return object
result
Call result.
exceptionDetails
Optional
Exception details.
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
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
Id of the script.
exceptionDetails
Optional
Exception details.
Runtime.disable #
Disables reporting of execution contexts creation.
Handles Runtime.disable request @cdp Runtime.disable If domain is already disabled, will return success.
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.
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
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.
This is mutually exclusive with uniqueContextId
, which offers an
alternative way to identify the execution context that is more reliable
in a multi-process environment.
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.
userGesture
Optional
boolean
Whether execution should be treated as initiated by user in the UI.
awaitPromise
Optional
boolean
Whether execution should await
for resulting value and return once awaited promise is
resolved.
throwOnSideEffect
Optional
boolean
Whether to throw an exception if side effect cannot be ruled out during evaluation.
This implies disableBreaks
below.
timeout
Optional
disableBreaks
Optional
boolean
Disable breakpoints during execution.
replMode
Optional
boolean
Setting this flag to true enables let
re-declaration and top-level await
.
Note that let
variables can only be re-declared if they originate from
replMode
themselves.
allowUnsafeEvalBlockedByCSP
Optional
boolean
The Content Security Policy (CSP) for the target might block 'unsafe-eval' which includes eval(), Function(), setTimeout() and setInterval() when called with non-callable arguments. This flag bypasses CSP for this evaluation and allows unsafe-eval. Defaults to true.
uniqueContextId
Optional
string
An alternative way to specify the execution context to evaluate in.
Compared to contextId that may be reused across processes, this is guaranteed to be
system-unique, so it can be used to prevent accidental evaluation of the expression
in context different than intended (e.g. as a result of navigation across process
boundaries).
This is mutually exclusive with contextId
.
serializationOptions
Optional
Specifies the result serialization. If provided, overrides
generatePreview
and returnByValue
.
Return object
result
Evaluation result.
exceptionDetails
Optional
Exception details.
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
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.
generatePreview
Optional
boolean
Whether preview should be generated for the results.
nonIndexedPropertiesOnly
Optional
boolean
If true, returns non-indexed properties only.
Return object
result
array[ PropertyDescriptor ]
Object properties.
internalProperties
Optional
array[ InternalPropertyDescriptor ]
Internal object properties (only of the element itself).
privateProperties
Optional
exceptionDetails
Optional
Exception details.
Runtime.globalLexicalScopeNames #
Returns all let, const and class variables from global scope.
Handles Runtime.globalLexicalScopeNames request @cdp Runtime.globalLexicalScopeNames Allowed even if domain is not enabled.
Parameters
executionContextId
Optional
Specifies in which execution context to lookup global scope variables.
Return object
names
array[ string
]
Runtime.getHeapUsage Experimental#
Returns the JavaScript heap usage. It is the total usage of the corresponding isolate not scoped to a particular Runtime.
Handles Runtime.getHeapUsage request @cdp Runtime.getHeapUsage Allowed even if domain is not enabled.
Return object
usedSize
number
Used heap size in bytes.
totalSize
number
Allocated heap size in bytes.
Events
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
, count
, timeEnd
args
array[ RemoteObject ]
Call arguments.
executionContextId
Identifier of the context where the call was made.
timestamp
Call timestamp.
stackTrace
Optional
Stack trace captured when the call was made. The async stack chain is automatically reported for
the following call types: assert
, error
, trace
, warning
. For other types the async call
chain can be retrieved using Debugger.getStackTrace
and stackTrace.parentId
field.
context
Optional
string
Console context descriptor for calls on non-default console context (not console.*): 'anonymous#unique-logger-id' for call on unnamed context, 'name#unique-logger-id' for call on named context.
Types
Runtime.CallFrame #
Stack entry for runtime errors and assertions.
Type: object
Properties
functionName
string
JavaScript function name.
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).
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
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
JavaScript stack trace if available.
exception
Optional
Exception object if available.
executionContextId
Optional
Identifier of the context where exception happened.
exceptionMetaData
Optional
object
Dictionary with entries of meta data that the client associated with this exception, such as information about associated network requests, etc.
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
, bigint
subtype
Optional
string
Object subtype hint. Specified for object
type values only.
NOTE: If you change anything here, make sure to also update
subtype
in ObjectPreview
and PropertyPreview
below.
Allowed values: array
, null
, node
, regexp
, date
, map
, set
, weakmap
, weakset
, iterator
, generator
, error
, proxy
, promise
, typedarray
, arraybuffer
, dataview
, webassemblymemory
, wasmvalue
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
Primitive value which can not be JSON-stringified does not have value
, but gets this
property.
description
Optional
string
String representation of the object.
deepSerializedValue
Optional
objectId
Optional
Unique object identifier (for non-primitive values).
preview
Optional
Preview containing abbreviated property values. Specified for object
type values only.
customPreview
Optional
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
Asynchronous JavaScript stack trace that preceded this stack, if available.
parentId
Optional
Asynchronous JavaScript stack trace that preceded this stack, if available.
Runtime.StackTraceId Experimental#
If debuggerId
is set stack trace comes from another debugger and can be resolved there. This
allows to track cross-debugger calls. See Runtime.StackTrace
and Debugger.paused
for usages.
Type: object
Properties
id
string
debuggerId
Optional