Module cdp::runtime

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.

Runtime

Commands

• Runtime.evaluate

  Evaluates expression on global object.

• Runtime.awaitPromise

  Add handler to promise with given promise object id.

• Runtime.callFunctionOn

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

• Runtime.getProperties

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

• Runtime.releaseObject

  Releases remote object with given id.

• Runtime.releaseObjectGroup

  Releases all remote objects that belong to a given group.

• 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

• Runtime.compileScript

  Compiles expression.

• Runtime.runScript

  Runs script with given id in a given context.

• Runtime.queryObjects Experimental

Events

• Runtime.executionContextCreated

  Issued when new execution context is created.

• Runtime.executionContextDestroyed

  Issued when execution context is destroyed.

• Runtime.executionContextsCleared

  Issued when all executionContexts were cleared in browser

• Runtime.exceptionThrown

  Issued when exception was thrown and unhandled.

• Runtime.exceptionRevoked

  Issued when unhandled exception was revoked.

• Runtime.consoleAPICalled

  Issued when console API was called.

• Runtime.inspectRequested

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

Types

• ScriptId

  Unique script identifier.

• RemoteObjectId

  Unique object identifier.

• UnserializableValue

  Primitive value which cannot be JSON-stringified.

• RemoteObject

  Mirror object referencing original JavaScript object.

• CustomPreview Experimental

• ObjectPreview Experimental

  Object containing abbreviated remote object value.

• PropertyPreview Experimental

• EntryPreview Experimental

• PropertyDescriptor

  Object property descriptor.

• InternalPropertyDescriptor

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

• CallArgument

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

• ExecutionContextId

  Id of an execution context.

• ExecutionContextDescription

  Description of an isolated world.

• ExceptionDetails

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

• Timestamp

  Number of milliseconds since epoch.

• CallFrame

  Stack entry for runtime errors and assertions.

• StackTrace

  Call frames for assertions or error messages.

Structs

AwaitPromiseCommand	Add handler to promise with given promise object id.
AwaitPromiseResponse	Add handler to promise with given promise object id.
CallArgument	Represents function call argument. Either remote object id objectId, primitive value, unserializable primitive value or neither of (for undefined) them should be specified.
CallFrame	Stack entry for runtime errors and assertions.
CallFunctionOnCommand	Calls function with given declaration on the given object. Object group of the result is inherited from the target object.
CallFunctionOnResponse	Calls function with given declaration on the given object. Object group of the result is inherited from the target object.
CompileScriptCommand	Compiles expression.
CompileScriptResponse	Compiles expression.
ConsoleApiCalledEvent	Issued when console API was called.
CustomPreview	[Experimental]
DisableCommand	Disables reporting of execution contexts creation.
DisableResponse	Disables reporting of execution contexts creation.
DiscardConsoleEntriesCommand	Discards collected exceptions and console API calls.
DiscardConsoleEntriesResponse	Discards collected exceptions and console API calls.
EnableCommand	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.
EnableResponse	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.
EntryPreview	[Experimental]
EvaluateCommand	Evaluates expression on global object.
EvaluateResponse	Evaluates expression on global object.
ExceptionDetails	Detailed information about exception (or error) that was thrown during script compilation or execution.
ExceptionRevokedEvent	Issued when unhandled exception was revoked.
ExceptionThrownEvent	Issued when exception was thrown and unhandled.
ExecutionContextCreatedEvent	Issued when new execution context is created.
ExecutionContextDescription	Description of an isolated world.
ExecutionContextDestroyedEvent	Issued when execution context is destroyed.
ExecutionContextsClearedEvent	Issued when all executionContexts were cleared in browser
GetPropertiesCommand	Returns properties of a given object. Object group of the result is inherited from the target object.
GetPropertiesResponse	Returns properties of a given object. Object group of the result is inherited from the target object.
InspectRequestedEvent	Issued when object should be inspected (for example, as a result of inspect() command line API call).
InternalPropertyDescriptor	Object internal property descriptor. This property isn't normally visible in JavaScript code.
ObjectPreview	[Experimental] Object containing abbreviated remote object value.
PropertyDescriptor	Object property descriptor.
PropertyPreview	[Experimental]
QueryObjectsCommand	[Experimental]
QueryObjectsResponse	[Experimental]
ReleaseObjectCommand	Releases remote object with given id.
ReleaseObjectGroupCommand	Releases all remote objects that belong to a given group.
ReleaseObjectGroupResponse	Releases all remote objects that belong to a given group.
ReleaseObjectResponse	Releases remote object with given id.
RemoteObject	Mirror object referencing original JavaScript object.
RunIfWaitingForDebuggerCommand	Tells inspected instance to run if it was waiting for debugger to attach.
RunIfWaitingForDebuggerResponse	Tells inspected instance to run if it was waiting for debugger to attach.
RunScriptCommand	Runs script with given id in a given context.
RunScriptResponse	Runs script with given id in a given context.
SetCustomObjectFormatterEnabledCommand	[Experimental]
SetCustomObjectFormatterEnabledResponse	[Experimental]
StackTrace	Call frames for assertions or error messages.

Enums

ConsoleApiCalledEventType	Used in the type of cdp::runtime::ConsoleApiCalledEvent::ty.
ObjectPreviewSubtype	[Experimental]
ObjectPreviewType	[Experimental]
PropertyPreviewSubtype	[Experimental]
PropertyPreviewType	[Experimental]
RemoteObjectSubtype	Used in the type of cdp::runtime::RemoteObject::subtype.
RemoteObjectType	Used in the type of cdp::runtime::RemoteObject::ty.
UnserializableValue	Primitive value which cannot be JSON-stringified.

Type Definitions

ExecutionContextId	Id of an execution context.
RemoteObjectId	Unique object identifier.
ScriptId	Unique script identifier.
Timestamp	Number of milliseconds since epoch.