Module runtime

Source
Expand description

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.

Structs§

AddBindingParams
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. addBinding
AddBindingParamsBuilder
AddBindingReturns
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. addBinding
AwaitPromiseParams
Add handler to promise with given promise object id. awaitPromise
AwaitPromiseParamsBuilder
AwaitPromiseReturns
Add handler to promise with given promise object id. awaitPromise
AwaitPromiseReturnsBuilder
CallArgument
Represents function call argument. Either remote object id objectId, primitive value, unserializable primitive value or neither of (for undefined) them should be specified. CallArgument
CallArgumentBuilder
CallFrame
Stack entry for runtime errors and assertions. CallFrame
CallFrameBuilder
CallFunctionOnParams
Calls function with given declaration on the given object. Object group of the result is inherited from the target object. callFunctionOn
CallFunctionOnParamsBuilder
CallFunctionOnReturns
Calls function with given declaration on the given object. Object group of the result is inherited from the target object. callFunctionOn
CallFunctionOnReturnsBuilder
CompileScriptParams
Compiles expression. compileScript
CompileScriptParamsBuilder
CompileScriptReturns
Compiles expression. compileScript
CompileScriptReturnsBuilder
CustomPreview
CustomPreviewBuilder
DeepSerializedValue
Represents deep serialized value. DeepSerializedValue
DeepSerializedValueBuilder
DisableParams
Disables reporting of execution contexts creation. disable
DisableReturns
Disables reporting of execution contexts creation. disable
DiscardConsoleEntriesParams
Discards collected exceptions and console API calls. discardConsoleEntries
DiscardConsoleEntriesReturns
Discards collected exceptions and console API calls. discardConsoleEntries
EnableParams
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. enable
EnableReturns
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. enable
EntryPreview
EntryPreviewBuilder
EvaluateParams
Evaluates expression on global object. evaluate
EvaluateParamsBuilder
EvaluateReturns
Evaluates expression on global object. evaluate
EvaluateReturnsBuilder
EventBindingCalled
Notification is issued every time when binding is called. bindingCalled
EventConsoleApiCalled
Issued when console API was called. consoleAPICalled
EventExceptionRevoked
Issued when unhandled exception was revoked. exceptionRevoked
EventExceptionThrown
Issued when exception was thrown and unhandled. exceptionThrown
EventExecutionContextCreated
Issued when new execution context is created. executionContextCreated
EventExecutionContextDestroyed
Issued when execution context is destroyed. executionContextDestroyed
EventExecutionContextsCleared
Issued when all executionContexts were cleared in browser executionContextsCleared
EventInspectRequested
Issued when object should be inspected (for example, as a result of inspect() command line API call). inspectRequested
ExceptionDetails
Detailed information about exception (or error) that was thrown during script compilation or execution. ExceptionDetails
ExceptionDetailsBuilder
ExecutionContextDescription
Description of an isolated world. ExecutionContextDescription
ExecutionContextDescriptionBuilder
ExecutionContextId
Id of an execution context. ExecutionContextId
GetExceptionDetailsParams
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. getExceptionDetails
GetExceptionDetailsParamsBuilder
GetExceptionDetailsReturns
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. getExceptionDetails
GetExceptionDetailsReturnsBuilder
GetHeapUsageParams
Returns the JavaScript heap usage. It is the total usage of the corresponding isolate not scoped to a particular Runtime. getHeapUsage
GetHeapUsageReturns
Returns the JavaScript heap usage. It is the total usage of the corresponding isolate not scoped to a particular Runtime. getHeapUsage
GetHeapUsageReturnsBuilder
GetIsolateIdParams
Returns the isolate id. getIsolateId
GetIsolateIdReturns
Returns the isolate id. getIsolateId
GetIsolateIdReturnsBuilder
GetPropertiesParams
Returns properties of a given object. Object group of the result is inherited from the target object. getProperties
GetPropertiesParamsBuilder
GetPropertiesReturns
Returns properties of a given object. Object group of the result is inherited from the target object. getProperties
GetPropertiesReturnsBuilder
GlobalLexicalScopeNamesParams
Returns all let, const and class variables from global scope. globalLexicalScopeNames
GlobalLexicalScopeNamesParamsBuilder
GlobalLexicalScopeNamesReturns
Returns all let, const and class variables from global scope. globalLexicalScopeNames
GlobalLexicalScopeNamesReturnsBuilder
InternalPropertyDescriptor
Object internal property descriptor. This property isn’t normally visible in JavaScript code. InternalPropertyDescriptor
InternalPropertyDescriptorBuilder
ObjectPreview
Object containing abbreviated remote object value. ObjectPreview
ObjectPreviewBuilder
PrivatePropertyDescriptor
Object private field descriptor. PrivatePropertyDescriptor
PrivatePropertyDescriptorBuilder
PropertyDescriptor
Object property descriptor. PropertyDescriptor
PropertyDescriptorBuilder
PropertyPreview
PropertyPreviewBuilder
QueryObjectsParams
QueryObjectsParamsBuilder
QueryObjectsReturns
QueryObjectsReturnsBuilder
ReleaseObjectGroupParams
Releases all remote objects that belong to a given group. releaseObjectGroup
ReleaseObjectGroupParamsBuilder
ReleaseObjectGroupReturns
Releases all remote objects that belong to a given group. releaseObjectGroup
ReleaseObjectParams
Releases remote object with given id. releaseObject
ReleaseObjectParamsBuilder
ReleaseObjectReturns
Releases remote object with given id. releaseObject
RemoteObject
Mirror object referencing original JavaScript object. RemoteObject
RemoteObjectBuilder
RemoteObjectId
Unique object identifier. RemoteObjectId
RemoveBindingParams
This method does not remove binding function from global object but unsubscribes current runtime agent from Runtime.bindingCalled notifications. removeBinding
RemoveBindingParamsBuilder
RemoveBindingReturns
This method does not remove binding function from global object but unsubscribes current runtime agent from Runtime.bindingCalled notifications. removeBinding
RunIfWaitingForDebuggerParams
Tells inspected instance to run if it was waiting for debugger to attach. runIfWaitingForDebugger
RunIfWaitingForDebuggerReturns
Tells inspected instance to run if it was waiting for debugger to attach. runIfWaitingForDebugger
RunScriptParams
Runs script with given id in a given context. runScript
RunScriptParamsBuilder
RunScriptReturns
Runs script with given id in a given context. runScript
RunScriptReturnsBuilder
ScriptId
Unique script identifier. ScriptId
SerializationOptions
Represents options for serialization. Overrides generatePreview and returnByValue. SerializationOptions
SerializationOptionsBuilder
SetAsyncCallStackDepthParams
Enables or disables async call stacks tracking. setAsyncCallStackDepth
SetAsyncCallStackDepthParamsBuilder
SetAsyncCallStackDepthReturns
Enables or disables async call stacks tracking. setAsyncCallStackDepth
SetCustomObjectFormatterEnabledParams
SetCustomObjectFormatterEnabledParamsBuilder
SetCustomObjectFormatterEnabledReturns
SetMaxCallStackSizeToCaptureParams
SetMaxCallStackSizeToCaptureParamsBuilder
SetMaxCallStackSizeToCaptureReturns
StackTrace
Call frames for assertions or error messages. StackTrace
StackTraceBuilder
StackTraceId
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. StackTraceId
StackTraceIdBuilder
TerminateExecutionParams
Terminate current or next JavaScript execution. Will cancel the termination when the outer-most script execution ends. terminateExecution
TerminateExecutionReturns
Terminate current or next JavaScript execution. Will cancel the termination when the outer-most script execution ends. terminateExecution
TimeDelta
Number of milliseconds. TimeDelta
Timestamp
Number of milliseconds since epoch. Timestamp
UniqueDebuggerId
Unique identifier of current debugger. UniqueDebuggerId
UnserializableValue
Primitive value which cannot be JSON-stringified. Includes values -0, NaN, Infinity, -Infinity, and bigint literals. UnserializableValue

Enums§

ConsoleApiCalledType
Type of the call.
DeepSerializedValueType
ObjectPreviewSubtype
Object subtype hint. Specified for object type values only.
ObjectPreviewType
Object type.
PropertyPreviewSubtype
Object subtype hint. Specified for object type values only.
PropertyPreviewType
Object type. Accessor means that the property itself is an accessor property.
RemoteObjectSubtype
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.
RemoteObjectType
Object type.
SerializationOptionsSerialization