cdp/dev.kdriver.cdp.domain/Runtime

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.

Constructors

Runtime

constructor(cdp: CDP)

Types

AddBindingParameter

@Serializable

data class AddBindingParameter(val name: String, val executionContextId: Int? = null, val executionContextName: String? = null)

AwaitPromiseParameter

@Serializable

data class AwaitPromiseParameter(val promiseObjectId: String, val returnByValue: Boolean? = null, val generatePreview: Boolean? = null)

AwaitPromiseReturn

@Serializable

data class AwaitPromiseReturn(val result: Runtime.RemoteObject, val exceptionDetails: Runtime.ExceptionDetails?)

BindingCalledParameter

@Serializable

data class BindingCalledParameter(val name: String, val payload: String, val executionContextId: Int)

Notification is issued every time when binding is called.

CallArgument

@Serializable

data class CallArgument(val value: JsonElement? = null, val unserializableValue: String? = null, val objectId: String? = null)

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

CallFrame

@Serializable

data class CallFrame(val functionName: String, val scriptId: String, val url: String, val lineNumber: Int, val columnNumber: Int)

Stack entry for runtime errors and assertions.

CallFunctionOnParameter

@Serializable

data class CallFunctionOnParameter(val functionDeclaration: String, val objectId: String? = null, val arguments: List<Runtime.CallArgument>? = null, val silent: Boolean? = null, val returnByValue: Boolean? = null, val generatePreview: Boolean? = null, val userGesture: Boolean? = null, val awaitPromise: Boolean? = null, val executionContextId: Int? = null, val objectGroup: String? = null, val throwOnSideEffect: Boolean? = null, val uniqueContextId: String? = null, val serializationOptions: Runtime.SerializationOptions? = null)

CallFunctionOnReturn

@Serializable

data class CallFunctionOnReturn(val result: Runtime.RemoteObject, val exceptionDetails: Runtime.ExceptionDetails?)

CompileScriptParameter

@Serializable

data class CompileScriptParameter(val expression: String, val sourceURL: String, val persistScript: Boolean, val executionContextId: Int? = null)

CompileScriptReturn

@Serializable

data class CompileScriptReturn(val scriptId: String?, val exceptionDetails: Runtime.ExceptionDetails?)

ConsoleAPICalledParameter

@Serializable

data class ConsoleAPICalledParameter(val type: String, val args: List<Runtime.RemoteObject>, val executionContextId: Int, val timestamp: Double, val stackTrace: Runtime.StackTrace? = null, val context: String? = null)

Issued when console API was called.

CustomPreview

@Serializable

data class CustomPreview(val header: String, val bodyGetterId: String? = null)

DeepSerializedValue

@Serializable

data class DeepSerializedValue(val type: String, val value: JsonElement? = null, val objectId: String? = null, val weakLocalObjectReference: Int? = null)

Represents deep serialized value.

EntryPreview

@Serializable

data class EntryPreview(val key: Runtime.ObjectPreview? = null, val value: Runtime.ObjectPreview)

EvaluateParameter

@Serializable

data class EvaluateParameter(val expression: String, val objectGroup: String? = null, val includeCommandLineAPI: Boolean? = null, val silent: Boolean? = null, val contextId: Int? = null, val returnByValue: Boolean? = null, val generatePreview: Boolean? = null, val userGesture: Boolean? = null, val awaitPromise: Boolean? = null, val throwOnSideEffect: Boolean? = null, val timeout: Double? = null, val disableBreaks: Boolean? = null, val replMode: Boolean? = null, val allowUnsafeEvalBlockedByCSP: Boolean? = null, val uniqueContextId: String? = null, val serializationOptions: Runtime.SerializationOptions? = null)

EvaluateReturn

@Serializable

data class EvaluateReturn(val result: Runtime.RemoteObject, val exceptionDetails: Runtime.ExceptionDetails?)

ExceptionDetails

@Serializable

data class ExceptionDetails(val exceptionId: Int, val text: String, val lineNumber: Int, val columnNumber: Int, val scriptId: String? = null, val url: String? = null, val stackTrace: Runtime.StackTrace? = null, val exception: Runtime.RemoteObject? = null, val executionContextId: Int? = null, val exceptionMetaData: Map<String, JsonElement>? = null)

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

ExceptionRevokedParameter

@Serializable

data class ExceptionRevokedParameter(val reason: String, val exceptionId: Int)

Issued when unhandled exception was revoked.

ExceptionThrownParameter

@Serializable

data class ExceptionThrownParameter(val timestamp: Double, val exceptionDetails: Runtime.ExceptionDetails)

Issued when exception was thrown and unhandled.

ExecutionContextCreatedParameter

@Serializable

data class ExecutionContextCreatedParameter(val context: Runtime.ExecutionContextDescription)

Issued when new execution context is created.

ExecutionContextDescription

@Serializable

data class ExecutionContextDescription(val id: Int, val origin: String, val name: String, val uniqueId: String, val auxData: Map<String, JsonElement>? = null)

Description of an isolated world.

ExecutionContextDestroyedParameter

@Serializable

data class ExecutionContextDestroyedParameter(val executionContextId: Int, val executionContextUniqueId: String)

Issued when execution context is destroyed.

GetExceptionDetailsParameter

@Serializable

data class GetExceptionDetailsParameter(val errorObjectId: String)

GetExceptionDetailsReturn

@Serializable

data class GetExceptionDetailsReturn(val exceptionDetails: Runtime.ExceptionDetails?)

GetHeapUsageReturn

@Serializable

data class GetHeapUsageReturn(val usedSize: Double, val totalSize: Double, val embedderHeapUsedSize: Double, val backingStorageSize: Double)

GetIsolateIdReturn

@Serializable

data class GetIsolateIdReturn(val id: String)

GetPropertiesParameter

@Serializable

data class GetPropertiesParameter(val objectId: String, val ownProperties: Boolean? = null, val accessorPropertiesOnly: Boolean? = null, val generatePreview: Boolean? = null, val nonIndexedPropertiesOnly: Boolean? = null)

GetPropertiesReturn

@Serializable

data class GetPropertiesReturn(val result: List<Runtime.PropertyDescriptor>, val internalProperties: List<Runtime.InternalPropertyDescriptor>?, val privateProperties: List<Runtime.PrivatePropertyDescriptor>?, val exceptionDetails: Runtime.ExceptionDetails?)

GlobalLexicalScopeNamesParameter

@Serializable

data class GlobalLexicalScopeNamesParameter(val executionContextId: Int? = null)

GlobalLexicalScopeNamesReturn

@Serializable

data class GlobalLexicalScopeNamesReturn(val names: List<String>)

InspectRequestedParameter

@Serializable

data class InspectRequestedParameter(val object: Runtime.RemoteObject, val hints: Map<String, JsonElement>, val executionContextId: Int? = null)

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

InternalPropertyDescriptor

@Serializable

data class InternalPropertyDescriptor(val name: String, val value: Runtime.RemoteObject? = null)

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

ObjectPreview

@Serializable

data class ObjectPreview(val type: String, val subtype: String? = null, val description: String? = null, val overflow: Boolean, val properties: List<Runtime.PropertyPreview>, val entries: List<Runtime.EntryPreview>? = null)

Object containing abbreviated remote object value.

PrivatePropertyDescriptor

@Serializable

data class PrivatePropertyDescriptor(val name: String, val value: Runtime.RemoteObject? = null, val get: Runtime.RemoteObject? = null, val set: Runtime.RemoteObject? = null)

Object private field descriptor.

PropertyDescriptor

@Serializable

data class PropertyDescriptor(val name: String, val value: Runtime.RemoteObject? = null, val writable: Boolean? = null, val get: Runtime.RemoteObject? = null, val set: Runtime.RemoteObject? = null, val configurable: Boolean, val enumerable: Boolean, val wasThrown: Boolean? = null, val isOwn: Boolean? = null, val symbol: Runtime.RemoteObject? = null)

Object property descriptor.

PropertyPreview

@Serializable

data class PropertyPreview(val name: String, val type: String, val value: String? = null, val valuePreview: Runtime.ObjectPreview? = null, val subtype: String? = null)

QueryObjectsParameter

@Serializable

data class QueryObjectsParameter(val prototypeObjectId: String, val objectGroup: String? = null)

QueryObjectsReturn

@Serializable

data class QueryObjectsReturn(val objects: Runtime.RemoteObject)

ReleaseObjectGroupParameter

@Serializable

data class ReleaseObjectGroupParameter(val objectGroup: String)

ReleaseObjectParameter

@Serializable

data class ReleaseObjectParameter(val objectId: String)

RemoteObject

@Serializable

data class RemoteObject(val type: String, val subtype: String? = null, val className: String? = null, val value: JsonElement? = null, val unserializableValue: String? = null, val description: String? = null, val deepSerializedValue: Runtime.DeepSerializedValue? = null, val objectId: String? = null, val preview: Runtime.ObjectPreview? = null, val customPreview: Runtime.CustomPreview? = null)

Mirror object referencing original JavaScript object.

RemoveBindingParameter

@Serializable

data class RemoveBindingParameter(val name: String)

RunScriptParameter

@Serializable

data class RunScriptParameter(val scriptId: String, val executionContextId: Int? = null, val objectGroup: String? = null, val silent: Boolean? = null, val includeCommandLineAPI: Boolean? = null, val returnByValue: Boolean? = null, val generatePreview: Boolean? = null, val awaitPromise: Boolean? = null)

RunScriptReturn

@Serializable

data class RunScriptReturn(val result: Runtime.RemoteObject, val exceptionDetails: Runtime.ExceptionDetails?)

SerializationOptions

@Serializable

data class SerializationOptions(val serialization: String, val maxDepth: Int? = null, val additionalParameters: Map<String, JsonElement>? = null)

Represents options for serialization. Overrides generatePreview and returnByValue.

SetAsyncCallStackDepthParameter

@Serializable

data class SetAsyncCallStackDepthParameter(val maxDepth: Int)

SetCustomObjectFormatterEnabledParameter

@Serializable

data class SetCustomObjectFormatterEnabledParameter(val enabled: Boolean)

SetMaxCallStackSizeToCaptureParameter

@Serializable

data class SetMaxCallStackSizeToCaptureParameter(val size: Int)

StackTrace

@Serializable

data class StackTrace(val description: String? = null, val callFrames: List<Runtime.CallFrame>, val parent: Runtime.StackTrace? = null, val parentId: Runtime.StackTraceId? = null)

Call frames for assertions or error messages.

StackTraceId

@Serializable

data class StackTraceId(val id: String, val debuggerId: String? = null)

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.

Properties

bindingCalled

val bindingCalled: Flow<Runtime.BindingCalledParameter>

Notification is issued every time when binding is called.

consoleAPICalled

val consoleAPICalled: Flow<Runtime.ConsoleAPICalledParameter>

Issued when console API was called.

exceptionRevoked

val exceptionRevoked: Flow<Runtime.ExceptionRevokedParameter>

Issued when unhandled exception was revoked.

exceptionThrown

val exceptionThrown: Flow<Runtime.ExceptionThrownParameter>

Issued when exception was thrown and unhandled.

executionContextCreated

val executionContextCreated: Flow<Runtime.ExecutionContextCreatedParameter>

Issued when new execution context is created.

executionContextDestroyed

val executionContextDestroyed: Flow<Runtime.ExecutionContextDestroyedParameter>

Issued when execution context is destroyed.

executionContextsCleared

val executionContextsCleared: Flow<Unit>

Issued when all executionContexts were cleared in browser

inspectRequested

val inspectRequested: Flow<Runtime.InspectRequestedParameter>

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

Functions

addBinding

suspend fun addBinding(args: Runtime.AddBindingParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun addBinding(name: String, executionContextId: Int? = null, executionContextName: String? = null)

If executionContextId is empty, adds binding with the given name on the global objects of all inspected contexts, including those created later, bindings survive reloads. Binding function takes exactly one argument, this argument should be string, in case of any other input, function throws an exception. Each binding function call produces Runtime.bindingCalled notification.

awaitPromise

suspend fun awaitPromise(args: Runtime.AwaitPromiseParameter, mode: CommandMode = CommandMode.DEFAULT): Runtime.AwaitPromiseReturn

suspend fun awaitPromise(promiseObjectId: String, returnByValue: Boolean? = null, generatePreview: Boolean? = null): Runtime.AwaitPromiseReturn

Add handler to promise with given promise object id.

callFunctionOn

suspend fun callFunctionOn(args: Runtime.CallFunctionOnParameter, mode: CommandMode = CommandMode.DEFAULT): Runtime.CallFunctionOnReturn

suspend fun callFunctionOn(functionDeclaration: String, objectId: String? = null, arguments: List<Runtime.CallArgument>? = null, silent: Boolean? = null, returnByValue: Boolean? = null, generatePreview: Boolean? = null, userGesture: Boolean? = null, awaitPromise: Boolean? = null, executionContextId: Int? = null, objectGroup: String? = null, throwOnSideEffect: Boolean? = null, uniqueContextId: String? = null, serializationOptions: Runtime.SerializationOptions? = null): Runtime.CallFunctionOnReturn

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

compileScript

suspend fun compileScript(args: Runtime.CompileScriptParameter, mode: CommandMode = CommandMode.DEFAULT): Runtime.CompileScriptReturn

suspend fun compileScript(expression: String, sourceURL: String, persistScript: Boolean, executionContextId: Int? = null): Runtime.CompileScriptReturn

Compiles expression.

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disables reporting of execution contexts creation.

discardConsoleEntries

suspend fun discardConsoleEntries(mode: CommandMode = CommandMode.DEFAULT)

Discards collected exceptions and console API calls.

enable

suspend fun enable(mode: CommandMode = CommandMode.DEFAULT)

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.

evaluate

suspend fun evaluate(args: Runtime.EvaluateParameter, mode: CommandMode = CommandMode.DEFAULT): Runtime.EvaluateReturn

suspend fun evaluate(expression: String, objectGroup: String? = null, includeCommandLineAPI: Boolean? = null, silent: Boolean? = null, contextId: Int? = null, returnByValue: Boolean? = null, generatePreview: Boolean? = null, userGesture: Boolean? = null, awaitPromise: Boolean? = null, throwOnSideEffect: Boolean? = null, timeout: Double? = null, disableBreaks: Boolean? = null, replMode: Boolean? = null, allowUnsafeEvalBlockedByCSP: Boolean? = null, uniqueContextId: String? = null, serializationOptions: Runtime.SerializationOptions? = null): Runtime.EvaluateReturn

Evaluates expression on global object.

getExceptionDetails

suspend fun getExceptionDetails(errorObjectId: String): Runtime.GetExceptionDetailsReturn

suspend fun getExceptionDetails(args: Runtime.GetExceptionDetailsParameter, mode: CommandMode = CommandMode.DEFAULT): Runtime.GetExceptionDetailsReturn

This method tries to lookup and populate exception details for a JavaScript Error object. Note that the stackTrace portion of the resulting exceptionDetails will only be populated if the Runtime domain was enabled at the time when the Error was thrown.

getHeapUsage

suspend fun getHeapUsage(mode: CommandMode = CommandMode.DEFAULT): Runtime.GetHeapUsageReturn

Returns the JavaScript heap usage. It is the total usage of the corresponding isolate not scoped to a particular Runtime.

getIsolateId

suspend fun getIsolateId(mode: CommandMode = CommandMode.DEFAULT): Runtime.GetIsolateIdReturn

Returns the isolate id.

getProperties

suspend fun getProperties(args: Runtime.GetPropertiesParameter, mode: CommandMode = CommandMode.DEFAULT): Runtime.GetPropertiesReturn

suspend fun getProperties(objectId: String, ownProperties: Boolean? = null, accessorPropertiesOnly: Boolean? = null, generatePreview: Boolean? = null, nonIndexedPropertiesOnly: Boolean? = null): Runtime.GetPropertiesReturn

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

globalLexicalScopeNames

suspend fun globalLexicalScopeNames(executionContextId: Int? = null): Runtime.GlobalLexicalScopeNamesReturn

suspend fun globalLexicalScopeNames(args: Runtime.GlobalLexicalScopeNamesParameter, mode: CommandMode = CommandMode.DEFAULT): Runtime.GlobalLexicalScopeNamesReturn

Returns all let, const and class variables from global scope.

queryObjects

suspend fun queryObjects(args: Runtime.QueryObjectsParameter, mode: CommandMode = CommandMode.DEFAULT): Runtime.QueryObjectsReturn

suspend fun queryObjects(prototypeObjectId: String, objectGroup: String? = null): Runtime.QueryObjectsReturn

releaseObject

suspend fun releaseObject(objectId: String)

suspend fun releaseObject(args: Runtime.ReleaseObjectParameter, mode: CommandMode = CommandMode.DEFAULT)

Releases remote object with given id.

releaseObjectGroup

suspend fun releaseObjectGroup(objectGroup: String)

suspend fun releaseObjectGroup(args: Runtime.ReleaseObjectGroupParameter, mode: CommandMode = CommandMode.DEFAULT)

Releases all remote objects that belong to a given group.

removeBinding

suspend fun removeBinding(name: String)

suspend fun removeBinding(args: Runtime.RemoveBindingParameter, mode: CommandMode = CommandMode.DEFAULT)

This method does not remove binding function from global object but unsubscribes current runtime agent from Runtime.bindingCalled notifications.

runIfWaitingForDebugger

suspend fun runIfWaitingForDebugger(mode: CommandMode = CommandMode.DEFAULT)

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

runScript

suspend fun runScript(args: Runtime.RunScriptParameter, mode: CommandMode = CommandMode.DEFAULT): Runtime.RunScriptReturn

suspend fun runScript(scriptId: String, executionContextId: Int? = null, objectGroup: String? = null, silent: Boolean? = null, includeCommandLineAPI: Boolean? = null, returnByValue: Boolean? = null, generatePreview: Boolean? = null, awaitPromise: Boolean? = null): Runtime.RunScriptReturn

Runs script with given id in a given context.

setAsyncCallStackDepth

suspend fun setAsyncCallStackDepth(maxDepth: Int)

suspend fun setAsyncCallStackDepth(args: Runtime.SetAsyncCallStackDepthParameter, mode: CommandMode = CommandMode.DEFAULT)

Enables or disables async call stacks tracking.

setCustomObjectFormatterEnabled

suspend fun setCustomObjectFormatterEnabled(enabled: Boolean)

suspend fun setCustomObjectFormatterEnabled(args: Runtime.SetCustomObjectFormatterEnabledParameter, mode: CommandMode = CommandMode.DEFAULT)

setMaxCallStackSizeToCapture

suspend fun setMaxCallStackSizeToCapture(size: Int)

suspend fun setMaxCallStackSizeToCapture(args: Runtime.SetMaxCallStackSizeToCaptureParameter, mode: CommandMode = CommandMode.DEFAULT)

terminateExecution

suspend fun terminateExecution(mode: CommandMode = CommandMode.DEFAULT)

Terminate current or next JavaScript execution. Will cancel the termination when the outer-most script execution ends.