stable (1.2) latest (tip-of-tree) v8-inspector (node) Home Domains Accessibility Animation ApplicationCache CSS CacheStorage Console DOM DOMDebugger DOMStorage Database Debugger DeviceOrientation Emulation HeapProfiler IO IndexedDB Input Inspector LayerTree Log Memory Network Page Profiler Runtime Schema Security ServiceWorker Storage SystemInfo Target Tethering Tracing
Chrome Debugging Protocol Viewer - latest (tip-of-tree)

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. evaluate

Evaluates expression on global object.

Parameters
expression
string Expression to evaluate.
objectGroup
string Symbolic group name that can be used to release multiple objects.
includeCommandLineAPI
boolean Determines whether Command Line API should be available during the evaluation.
silent
boolean In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
contextId
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
boolean Whether the result is expected to be a JSON object that should be sent by value.
generatePreview
boolean Whether preview should be generated for the result. Experimental
userGesture
boolean Whether execution should be treated as initiated by user in the UI. Experimental
awaitPromise
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
ExceptionDetails Exception details.

Runtime. awaitPromise

Add handler to promise with given promise object id.

Parameters
promiseObjectId
RemoteObjectId Identifier of the promise.
returnByValue
boolean Whether the result is expected to be a JSON object that should be sent by value.
generatePreview
boolean Whether preview should be generated for the result.
Return object
result
RemoteObject Promise result. Will contain rejected value if promise was rejected.
exceptionDetails
ExceptionDetails Exception details if stack strace is available.

Runtime. callFunctionOn

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

Parameters
objectId
RemoteObjectId Identifier of the object to call function on.
functionDeclaration
string Declaration of the function to call.
arguments
array [ CallArgument ] Call arguments. All call arguments must belong to the same JavaScript world as the target object.
Array element:
Call argument.
silent
boolean In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
returnByValue
boolean Whether the result is expected to be a JSON object which should be sent by value.
generatePreview
boolean Whether preview should be generated for the result. Experimental
userGesture
boolean Whether execution should be treated as initiated by user in the UI. Experimental
awaitPromise
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
ExceptionDetails Exception details.

Runtime. getProperties

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

Parameters
objectId
RemoteObjectId Identifier of the object to return properties for.
ownProperties
boolean If true, returns properties belonging only to the element itself, not to its prototype chain.
accessorPropertiesOnly
boolean If true, returns accessor properties (with getter/setter) only; internal properties are not returned either. Experimental
generatePreview
boolean Whether preview should be generated for the results. Experimental
Return object
result
array [ PropertyDescriptor ] Object properties.
internalProperties
array [ InternalPropertyDescriptor ] Internal object properties (only of the element itself).
exceptionDetails
ExceptionDetails Exception details.

Runtime. releaseObject

Releases remote object with given id.

Parameters
objectId
RemoteObjectId Identifier of the object to release.

Runtime. releaseObjectGroup

Releases all remote objects that belong to a given group.

Parameters
objectGroup
string Symbolic object group name.

Runtime. runIfWaitingForDebugger

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

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.

Runtime. disable

Disables reporting of execution contexts creation.

Runtime. discardConsoleEntries

Discards collected exceptions and console API calls.

Runtime. setCustomObjectFormatterEnabled

Experimental

Parameters
enabled
boolean

Runtime. compileScript

Compiles expression.

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
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
ScriptId Id of the script.
exceptionDetails
ExceptionDetails Exception details.

Runtime. runScript

Runs script with given id in a given context.

Parameters
scriptId
ScriptId Id of the script to run.
executionContextId
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
string Symbolic group name that can be used to release multiple objects.
silent
boolean In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
includeCommandLineAPI
boolean Determines whether Command Line API should be available during the evaluation.
returnByValue
boolean Whether the result is expected to be a JSON object which should be sent by value.
generatePreview
boolean Whether preview should be generated for the result.
awaitPromise
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
ExceptionDetails Exception details.

Events

Runtime. executionContextCreated

Issued when new execution context is created.

Parameters
context
ExecutionContextDescription A newly created execution context.

Runtime. executionContextDestroyed

Issued when execution context is destroyed.

Parameters
executionContextId
ExecutionContextId Id of the destroyed context

Runtime. executionContextsCleared

Issued when all executionContexts were cleared in browser

Runtime. exceptionThrown

Issued when exception was thrown and unhandled.

Parameters
timestamp
Timestamp Timestamp of the exception.
exceptionDetails
ExceptionDetails

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.

Runtime. consoleAPICalled

Issued when console API was called.

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
ExecutionContextId Identifier of the context where the call was made.
timestamp
Timestamp Call timestamp.
stackTrace
StackTrace Stack trace captured when the call was made.

Runtime. inspectRequested

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

Parameters
object
RemoteObject
hints
object

Types

ScriptId

Unique script identifier.

Type: string

RemoteObjectId

Unique object identifier.

Type: string

UnserializableValue

Primitive value which cannot be JSON-stringified.

Type: string

Allowed values

Infinity, NaN, -Infinity, -0.

RemoteObject

Mirror object referencing original JavaScript object.

Type: object

Properties
type
string Object type. Allowed values: object, function, undefined, string, number, boolean, symbol.
subtype
string Object subtype hint. Specified for object type values only. Allowed values: array, null, node, regexp, date, map, set, weakmap, weakset, iterator, generator, error, proxy, promise, typedarray.
className
string Object class (constructor) name. Specified for object type values only.
value
any Remote object value in case of primitive values or JSON values (if it was requested).
unserializableValue
UnserializableValue Primitive value which can not be JSON-stringified does not have value, but gets this property.
description
string String representation of the object.
objectId
RemoteObjectId Unique object identifier (for non-primitive values).
preview
ObjectPreview Preview containing abbreviated property values. Specified for object type values only. Experimental
customPreview
CustomPreview Experimental

CustomPreview

Experimental

Type: object

Properties
header
string
hasBody
boolean
formatterObjectId
RemoteObjectId
bindRemoteObjectFunctionId
RemoteObjectId
configObjectId
RemoteObjectId

ObjectPreview

Object containing abbreviated remote object value. Experimental

Type: object

Properties
type
string Object type. Allowed values: object, function, undefined, string, number, boolean, symbol.
subtype
string Object subtype hint. Specified for object type values only. Allowed values: array, null, node, regexp, date, map, set, weakmap, weakset, iterator, generator, error.
description
string String representation of the object.
overflow
boolean True iff some of the properties or entries of the original object did not fit.
properties
array [ PropertyPreview ] List of the properties.
entries
array [ EntryPreview ] List of the entries. Specified for map and set subtype values only.

PropertyPreview

Experimental

Type: object

Properties
name
string Property name.
type
string Object type. Accessor means that the property itself is an accessor property. Allowed values: object, function, undefined, string, number, boolean, symbol, accessor.
value
string User-friendly property value string.
valuePreview
ObjectPreview Nested value preview.
subtype
string Object subtype hint. Specified for object type values only. Allowed values: array, null, node, regexp, date, map, set, weakmap, weakset, iterator, generator, error.

EntryPreview

Experimental

Type: object

Properties
key
ObjectPreview Preview of the key. Specified for map-like collection entries.
value
ObjectPreview Preview of the value.

PropertyDescriptor

Object property descriptor.

Type: object

Properties
name
string Property name or symbol description.
value
RemoteObject The value associated with the property.
writable
boolean True if the value associated with the property may be changed (data descriptors only).
get
RemoteObject A function which serves as a getter for the property, or undefined if there is no getter (accessor descriptors only).
set
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
boolean True if the result was thrown during the evaluation.
isOwn
boolean True if the property is owned for the object.
symbol
RemoteObject Property symbol object, if the property is of the symbol type.

InternalPropertyDescriptor

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

Type: object

Properties
name
string Conventional property name.
value
RemoteObject The value associated with the property.

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
any Primitive value.
unserializableValue
UnserializableValue Primitive value which can not be JSON-stringified.
objectId
RemoteObjectId Remote object handle.

ExecutionContextId

Id of an execution context.

Type: integer

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
object Embedder-specific auxiliary data.

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
ScriptId Script ID of the exception location.
url
string URL of the exception location, to be used when the script was not reported.
stackTrace
StackTrace JavaScript stack trace if available.
exception
RemoteObject Exception object if available.
executionContextId
ExecutionContextId Identifier of the context where exception happened.

Timestamp

Number of milliseconds since epoch.

Type: number

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).

StackTrace

Call frames for assertions or error messages.

Type: object

Properties
description
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
StackTrace Asynchronous JavaScript stack trace that preceded this stack, if available.
promiseCreationFrame
CallFrame Creation frame of the Promise which produced the next synchronous trace when resolved, if available. Experimental