Name	Description	Flags
clearMessages	Does nothing.	-
disable	Disables console domain, prevents further console messages from being reported to the client.	-
enable	Enables console domain, sends the messages collected so far to the client by means of the `messageAdded` notification.	-

Debugger

Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.

Dependencies: RunTime

types

Type ID

Type

Description

Flags

BreakpointId

String

Breakpoint identifier.

CallFrameId

String

Call frame identifier.

Location

Object

Location in the source code.

PROPERTIES:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Script identifier as reported in the `Debugger.scriptParsed`.	-
lineNumber	Integer	Line number in the script (0-based).	-
columnNumber	Integer	Column number in the script (0-based).	[OPTIONAL]

ScriptPosition

Object

Location in the source code.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
lineNumber	Integer	-	-
columnNumber	Integer	-	-

LocationRange

Object

Location range within one script.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	-	-
start	$REF: ScriptPosition	-	-
end	$REF: ScriptPosition	-	-

CallFrame

Object

JavaScript call frame. Array of call frames form the call stack.

PROPERTIES:

Name	Type	Description	Flags
callFrameId	$REF: CallFrameId	Call frame identifier. This identifier is only valid while the virtual machine is paused.	-
functionName	String	Name of the JavaScript function called on this call frame.	-
functionLocation	$REF: Location	Location in the source code.	[OPTIONAL]
location	$REF: Location	Location in the source code.	-
url	String	JavaScript script name or url. Deprecated in favor of using the `location.scriptId` to resolve the URL via a previously sent `Debugger.scriptParsed` event.	[DEPRECATED]
scopeChain	Array (of) $REF: Scope	Scope chain for this call frame.	-
this	$REF: RunTime.RemoteObject	`this` object for this call frame.	-
returnValue	$REF: RunTime.RemoteObject	The value being returned, if the function is at return point.	[OPTIONAL]
canBeRestarted	Boolean	Valid only while the VM is paused and indicates whether this frame can be restarted or not. Note that a `true` value here does not guarantee that Debugger#restartFrame with this CallFrameId will be successful, but it is very likely.	[OPTIONAL] [EXPERIMENTAL]

Scope

Object

Scope description.

PROPERTIES:

Name	Type	Description	Flags
type	"global", "local", "with", "closure", "catch", "block", "script", "eval", "module", "wasm-expression-stack"String [Hover] Enum	Scope type.	-
object	$REF: RunTime.RemoteObject	Object representing the scope. For `global` and `with` scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties.	-
name	String	-	[OPTIONAL]
startLocation	$REF: Location	Location in the source code where scope starts	[OPTIONAL]
endLocation	$REF: Location	Location in the source code where scope ends	[OPTIONAL]

SearchMatch

Object

Search match for resource.

PROPERTIES:

Name	Type	Description	Flags
lineNumber	Number	Line number in resource content.	-
lineContent	String	Line with match content.	-

BreakLocation

Object

PROPERTIES:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Script identifier as reported in the `Debugger.scriptParsed`.	-
lineNumber	Integer	Line number in the script (0-based).	-
columnNumber	Integer	Column number in the script (0-based).	[OPTIONAL]
type	"debuggerStatement", "call", "return"String [Hover] Enum	-	[OPTIONAL]

WasmDisassemblyChunk

Object

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
lines	Array (of) String	The next chunk of disassembled lines.	-
bytecodeOffsets	Array (of) Integer	The bytecode offsets describing the start of each line.	-

ScriptLanguage

Enum of possible script languages.

DebugSymbols

Object

Debug symbols available for a wasm script.

PROPERTIES:

Name	Type	Description	Flags
type	"SourceMap", "EmbeddedDWARF", "ExternalDWARF"String [Hover] Enum	Type of the debug symbols.	-
externalURL	String	URL of the external symbol source.	[OPTIONAL]

ResolvedBreakpoint

Object

PROPERTIES:

Name	Type	Description	Flags
breakpointId	$REF: BreakpointId	Breakpoint unique identifier.	-
location	$REF: Location	Actual breakpoint location.	-

commands

Name

Description

Flags

continueToLocation

Continues execution until specific location is reached.

PARAMETERS:

Name	Type	Description	Flags
location	$REF: Location	Location to continue to.	-
targetCallFrames	"any", "current"String [Hover] Enum	-	[OPTIONAL]

disable

Disables debugger for given page.

enable

Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.

PARAMETERS:

Name	Type	Description	Flags
maxScriptsCacheSize	Number	The maximum size in bytes of collected scripts (not referenced by other heap objects) the debugger can hold. Puts no limit if parameter is omitted.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
debuggerId	$REF: RunTime.UniqueDebuggerId	Unique identifier of the debugger.	[EXPERIMENTAL]

evaluateOnCallFrame

Evaluates expression on a given call frame.

PARAMETERS:

Name	Type	Description	Flags
callFrameId	$REF: CallFrameId	Call frame identifier to evaluate on.	-
expression	String	Expression to evaluate.	-
objectGroup	String	String object group name to put result into (allows rapid releasing resulting object handles using `releaseObjectGroup`).	[OPTIONAL]
includeCommandLineAPI	Boolean	Specifies whether command line API should be available to the evaluated expression, defaults to false.	[OPTIONAL]
silent	Boolean	In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides `setPauseOnException` state.	[OPTIONAL]
returnByValue	Boolean	Whether the result is expected to be a JSON object that should be sent by value.	[OPTIONAL]
generatePreview	Boolean	Whether preview should be generated for the result.	[OPTIONAL] [EXPERIMENTAL]
throwOnSideEffect	Boolean	Whether to throw an exception if side effect cannot be ruled out during evaluation.	[OPTIONAL]
timeout	$REF: RunTime.TimeDelta	Terminate execution after timing out (number of milliseconds).	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
result	$REF: RunTime.RemoteObject	Object wrapper for the evaluation result.	-
exceptionDetails	$REF: RunTime.ExceptionDetails	Exception details.	[OPTIONAL]

getPossibleBreakpoints

Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.

PARAMETERS:

Name	Type	Description	Flags
start	$REF: Location	Start of range to search possible breakpoint locations in.	-
end	$REF: Location	End of range to search possible breakpoint locations in (excluding). When not specified, end of scripts is used as end of range.	[OPTIONAL]
restrictToFunction	Boolean	Only consider locations which are in the same (non-nested) function as start.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
locations	Array (of) $REF: BreakLocation	List of the possible breakpoint locations.	-

getScriptSource

Returns source for the script with given id.

PARAMETERS:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Id of the script to get source for.	-

RETURNS:

Name	Type	Description	Flags
scriptSource	String	Script source (empty in case of Wasm bytecode).	-
bytecode	String	Wasm bytecode. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]

disassembleWasmModule

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Id of the script to disassemble	-

RETURNS:

Name	Type	Description	Flags
streamId	String	For large modules, return a stream from which additional chunks of disassembly can be read successively.	[OPTIONAL]
totalNumberOfLines	Integer	The total number of lines in the disassembly text.	-
functionBodyOffsets	Array (of) Integer	The offsets of all function bodies, in the format [start1, end1, start2, end2, ...] where all ends are exclusive.	-
chunk	$REF: WasmDisassemblyChunk	The first chunk of disassembly.	-

nextWasmDisassemblyChunk

Disassemble the next chunk of lines for the module corresponding to the stream. If disassembly is complete, this API will invalidate the streamId and return an empty chunk. Any subsequent calls for the now invalid stream will return errors.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
streamId	String	-	-

RETURNS:

Name	Type	Description	Flags
chunk	$REF: WasmDisassemblyChunk	The next chunk of disassembly.	-

getWasmBytecode

This command is deprecated. Use getScriptSource instead.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Id of the Wasm script to get source for.	-

RETURNS:

Name	Type	Description	Flags
bytecode	String	Script source. (Encoded as a base64 string when passed over JSON)	-

getStackTrace

Returns stack trace with given `stackTraceId`.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
stackTraceId	$REF: RunTime.StackTraceId	-	-

RETURNS:

Name	Type	Description	Flags
stackTrace	$REF: RunTime.StackTrace	-	-

pause

Stops on the next JavaScript statement.

pauseOnAsyncCall

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
parentStackTraceId	$REF: RunTime.StackTraceId	Debugger will pause when async call with given stack trace is started.	-

removeBreakpoint

Removes JavaScript breakpoint.

PARAMETERS:

Name	Type	Description	Flags
breakpointId	$REF: BreakpointId	-	-

restartFrame

Restarts particular call frame from the beginning. The old, deprecated behavior of `restartFrame` is to stay paused and allow further CDP commands after a restart was scheduled. This can cause problems with restarting, so we now continue execution immediatly after it has been scheduled until we reach the beginning of the restarted frame. To stay back-wards compatible, `restartFrame` now expects a `mode` parameter to be present. If the `mode` parameter is missing, `restartFrame` errors out. The various return values are deprecated and `callFrames` is always empty. Use the call frames from the `Debugger#paused` events instead, that fires once V8 pauses at the beginning of the restarted function.

PARAMETERS:

Name	Type	Description	Flags
callFrameId	$REF: CallFrameId	Call frame identifier to evaluate on.	-
mode	"StepInto"String [Hover] Enum	The `mode` parameter must be present and set to 'StepInto', otherwise `restartFrame` will error out.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
callFrames	Array (of) $REF: CallFrame	New stack trace.	[DEPRECATED]
asyncStackTrace	$REF: RunTime.StackTrace	Async stack trace, if any.	[OPTIONAL] [DEPRECATED]
asyncStackTraceId	$REF: RunTime.StackTraceId	Async stack trace, if any.	[OPTIONAL] [DEPRECATED]

resume

Resumes JavaScript execution.

PARAMETERS:

Name	Type	Description	Flags
terminateOnResume	Boolean	Set to true to terminate execution upon resuming execution. In contrast to RunTime.terminateExecution, this will allows to execute further JavaScript (i.e. via evaluation) until execution of the paused code is actually resumed, at which point termination is triggered. If execution is currently not paused, this parameter has no effect.	[OPTIONAL]

searchInContent

Searches for given string in script content.

PARAMETERS:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Id of the script to search in.	-
query	String	String to search for.	-
caseSensitive	Boolean	If true, search is case sensitive.	[OPTIONAL]
isRegex	Boolean	If true, treats string parameter as regex.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
result	Array (of) $REF: SearchMatch	List of search matches.	-

setAsyncCallStackDepth

Enables or disables async call stacks tracking.

PARAMETERS:

Name	Type	Description	Flags
maxDepth	Integer	Maximum depth of async call stacks. Setting to `0` will effectively disable collecting async call stacks (default).	-

setBlackboxExecutionContexts

Replace previous blackbox execution contexts with passed ones. Forces backend to skip stepping/pausing in scripts in these execution contexts. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
uniqueIds	Array (of) String	Array of execution context unique ids for the debugger to ignore.	-

setBlackboxPatterns

Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
patterns	Array (of) String	Array of regexps that will be used to check script url for blackbox state.	-
skipAnonymous	Boolean	If true, also ignore scripts with no source url.	[OPTIONAL]

setBlackboxedRanges

Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Id of the script.	-
positions	Array (of) $REF: ScriptPosition	-	-

setBreakpoint

Sets JavaScript breakpoint at a given location.

PARAMETERS:

Name	Type	Description	Flags
location	$REF: Location	Location to set breakpoint in.	-
condition	String	Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
breakpointId	$REF: BreakpointId	Id of the created breakpoint for further reference.	-
actualLocation	$REF: Location	Location this breakpoint resolved into.	-

setInstrumentationBreakpoint

Sets instrumentation breakpoint.

PARAMETERS:

Name	Type	Description	Flags
instrumentation	"beforeScriptExecution", "beforeScriptWithSourceMapExecution"String [Hover] Enum	Instrumentation name.	-

RETURNS:

Name	Type	Description	Flags
breakpointId	$REF: BreakpointId	Id of the created breakpoint for further reference.	-

setBreakpointByUrl

Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in `locations` property. Further matching script parsing will result in subsequent `breakpointResolved` events issued. This logical breakpoint will survive page reloads.

PARAMETERS:

Name	Type	Description	Flags
lineNumber	Integer	Line number to set breakpoint at.	-
url	String	URL of the resources to set breakpoint on.	[OPTIONAL]
urlRegex	String	Regex pattern for the URLs of the resources to set breakpoints on. Either `url` or `urlRegex` must be specified.	[OPTIONAL]
scriptHash	String	Script hash of the resources to set breakpoint on.	[OPTIONAL]
columnNumber	Integer	Offset in the line to set breakpoint at.	[OPTIONAL]
condition	String	Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
breakpointId	$REF: BreakpointId	Id of the created breakpoint for further reference.	-
locations	Array (of) $REF: Location	List of the locations this breakpoint resolved into upon addition.	-

setBreakpointOnFunctionCall

Sets JavaScript breakpoint before each call to the given function. If another function was created from the same source as a given one, calling it will also trigger the breakpoint.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
objectId	$REF: RunTime.RemoteObjectId	Function object id.	-
condition	String	Expression to use as a breakpoint condition. When specified, debugger will stop on the breakpoint if this expression evaluates to true.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
breakpointId	$REF: BreakpointId	Id of the created breakpoint for further reference.	-

setBreakpointsActive

Activates / deactivates all breakpoints on the page.

PARAMETERS:

Name	Type	Description	Flags
active	Boolean	New value for breakpoints active state.	-

setPauseOnExceptions

Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions, or caught exceptions, no exceptions. Initial pause on exceptions state is `none`.

PARAMETERS:

Name	Type	Description	Flags
state	"none", "caught", "uncaught", "all"String [Hover] Enum	Pause on exceptions mode.	-

setReturnValue

Changes return value in top frame. Available only at return break position.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
newValue	$REF: RunTime.CallArgument	New return value.	-

setScriptSource

Edits JavaScript source live. In general, functions that are currently on the stack can not be edited with a single exception: If the edited function is the top-most stack frame and that is the only activation of that function on the stack. In this case the live edit will be successful and a `Debugger.restartFrame` for the top-most function is automatically triggered.

PARAMETERS:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Id of the script to edit.	-
scriptSource	String	New content of the script.	-
dryRun	Boolean	If true the change will not actually be applied. Dry run may be used to get result description without actually modifying the code.	[OPTIONAL]
allowTopFrameEditing	Boolean	If true, then `scriptSource` is allowed to change the function on top of the stack as long as the top-most stack frame is the only activation of that function.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
callFrames	Array (of) $REF: CallFrame	New stack trace in case editing has happened while VM was stopped.	[OPTIONAL] [DEPRECATED]
stackChanged	Boolean	Whether current call stack was modified after applying the changes.	[OPTIONAL] [DEPRECATED]
asyncStackTrace	$REF: RunTime.StackTrace	Async stack trace, if any.	[OPTIONAL] [DEPRECATED]
asyncStackTraceId	$REF: RunTime.StackTraceId	Async stack trace, if any.	[OPTIONAL] [DEPRECATED]
status	"Ok", "CompileError", "BlockedByActiveGenerator", "BlockedByActiveFunction", "BlockedByTopLevelEsModuleChange"String [Hover] Enum	Whether the operation was successful or not. Only `Ok` denotes a successful live edit while the other enum variants denote why the live edit failed.	[EXPERIMENTAL]
exceptionDetails	$REF: RunTime.ExceptionDetails	Exception details if any. Only present when `status` is `CompileError`.	[OPTIONAL]

setSkipAllPauses

Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).

PARAMETERS:

Name	Type	Description	Flags
skip	Boolean	New value for skip pauses state.	-

setVariableValue

Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.

PARAMETERS:

Name	Type	Description	Flags
scopeNumber	Integer	0-based number of scope as was listed in scope chain. Only 'local', 'closure' and 'catch' scope types are allowed. Other scopes could be manipulated manually.	-
variableName	String	Variable name.	-
newValue	$REF: RunTime.CallArgument	New variable value.	-
callFrameId	$REF: CallFrameId	Id of callframe that holds variable.	-

stepInto

Steps into the function call.

PARAMETERS:

Name	Type	Description	Flags
breakOnAsyncCall	Boolean	Debugger will pause on the execution of the first async task which was scheduled before next pause.	[OPTIONAL] [EXPERIMENTAL]
skipList	Array (of) $REF: LocationRange	The skipList specifies location ranges that should be skipped on step into.	[OPTIONAL] [EXPERIMENTAL]

stepOut

Steps out of the function call.

stepOver

Steps over the statement.

PARAMETERS:

Name	Type	Description	Flags
skipList	Array (of) $REF: LocationRange	The skipList specifies location ranges that should be skipped on step over.	[OPTIONAL] [EXPERIMENTAL]

events

Name

Description

Flags

breakpointResolved

Fired when breakpoint is resolved to an actual script and location. Deprecated in favor of `resolvedBreakpoints` in the `scriptParsed` event.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
breakpointId	$REF: BreakpointId	Breakpoint unique identifier.	-
location	$REF: Location	Actual breakpoint location.	-

paused

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

PARAMETERS:

Name	Type	Description	Flags
callFrames	Array (of) $REF: CallFrame	Call stack the virtual machine stopped on.	-
reason	"ambiguous", "assert", "CSPViolation", "debugCommand", "DOM", "EventListener", "exception", "instrumentation", "OOM", "other", "promiseRejection", "XHR", "step"String [Hover] Enum	Pause reason.	-
data	Object	Object containing break-specific auxiliary properties.	[OPTIONAL]
hitBreakpoints	Array (of) String	Hit breakpoints IDs	[OPTIONAL]
asyncStackTrace	$REF: RunTime.StackTrace	Async stack trace, if any.	[OPTIONAL]
asyncStackTraceId	$REF: RunTime.StackTraceId	Async stack trace, if any.	[OPTIONAL] [EXPERIMENTAL]
asyncCallStackTraceId	$REF: RunTime.StackTraceId	Never present, will be removed.	[OPTIONAL] [EXPERIMENTAL] [DEPRECATED]

resumed

Fired when the virtual machine resumed execution.

scriptFailedToParse

Fired when virtual machine fails to parse the script.

PARAMETERS:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Identifier of the script parsed.	-
url	String	URL or name of the script parsed (if any).	-
startLine	Integer	Line offset of the script within the resource with given URL (for script tags).	-
startColumn	Integer	Column offset of the script within the resource with given URL.	-
endLine	Integer	Last line of the script.	-
endColumn	Integer	Length of the last line of the script.	-
executionContextId	$REF: RunTime.ExecutionContextId	Specifies script creation context.	-
hash	String	Content hash of the script, SHA-256.	-
buildId	String	For Wasm modules, the content of the `build_id` custom section. For JavaScript the `debugId` magic comment.	-
executionContextAuxData	Object	Embedder-specific auxiliary data likely matching {isDefault: boolean, type: 'default'\|'isolated'\|'worker', frameId: string}	[OPTIONAL]
sourceMapURL	String	URL of source map associated with script (if any).	[OPTIONAL]
hasSourceURL	Boolean	True, if this script has sourceURL.	[OPTIONAL]
isModule	Boolean	True, if this script is ES6 module.	[OPTIONAL]
length	Integer	This script length.	[OPTIONAL]
stackTrace	$REF: RunTime.StackTrace	JavaScript top stack frame of where the script parsed event was triggered if available.	[OPTIONAL] [EXPERIMENTAL]
codeOffset	Integer	If the scriptLanguage is WebAssembly, the code section offset in the module.	[OPTIONAL] [EXPERIMENTAL]
scriptLanguage	$REF: Debugger.ScriptLanguage	The language of the script.	[OPTIONAL] [EXPERIMENTAL]
embedderName	String	The name the embedder supplied for this script.	[OPTIONAL] [EXPERIMENTAL]

scriptParsed

Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.

PARAMETERS:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	Identifier of the script parsed.	-
url	String	URL or name of the script parsed (if any).	-
startLine	Integer	Line offset of the script within the resource with given URL (for script tags).	-
startColumn	Integer	Column offset of the script within the resource with given URL.	-
endLine	Integer	Last line of the script.	-
endColumn	Integer	Length of the last line of the script.	-
executionContextId	$REF: RunTime.ExecutionContextId	Specifies script creation context.	-
hash	String	Content hash of the script, SHA-256.	-
buildId	String	For Wasm modules, the content of the `build_id` custom section. For JavaScript the `debugId` magic comment.	-
executionContextAuxData	Object	Embedder-specific auxiliary data likely matching {isDefault: boolean, type: 'default'\|'isolated'\|'worker', frameId: string}	[OPTIONAL]
isLiveEdit	Boolean	True, if this script is generated as a result of the live edit operation.	[OPTIONAL] [EXPERIMENTAL]
sourceMapURL	String	URL of source map associated with script (if any).	[OPTIONAL]
hasSourceURL	Boolean	True, if this script has sourceURL.	[OPTIONAL]
isModule	Boolean	True, if this script is ES6 module.	[OPTIONAL]
length	Integer	This script length.	[OPTIONAL]
stackTrace	$REF: RunTime.StackTrace	JavaScript top stack frame of where the script parsed event was triggered if available.	[OPTIONAL] [EXPERIMENTAL]
codeOffset	Integer	If the scriptLanguage is WebAssembly, the code section offset in the module.	[OPTIONAL] [EXPERIMENTAL]
scriptLanguage	$REF: Debugger.ScriptLanguage	The language of the script.	[OPTIONAL] [EXPERIMENTAL]
debugSymbols	Array (of) $REF: Debugger.DebugSymbols	If the scriptLanguage is WebAssembly, the source of debug symbols for the module.	[OPTIONAL] [EXPERIMENTAL]
embedderName	String	The name the embedder supplied for this script.	[OPTIONAL] [EXPERIMENTAL]
resolvedBreakpoints	Array (of) $REF: ResolvedBreakpoint	The list of set breakpoints in this script if calls to `setBreakpointByUrl` matches this script's URL or hash. Clients that use this list can ignore the `breakpointResolved` event. They are equivalent.	[OPTIONAL] [EXPERIMENTAL]

HeapProfiler

[Experimental]

-

Dependencies: RunTime

types

Type ID

Type

Description

Flags

HeapSnapshotObjectId

String

Heap snapshot object id.

SamplingHeapProfileNode

Object

Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes.

PROPERTIES:

Name	Type	Description	Flags
callFrame	$REF: RunTime.CallFrame	Function location.	-
selfSize	Number	Allocations size in bytes for the node excluding children.	-
id	Integer	Node id. Ids are unique across all profiles collected between startSampling and stopSampling.	-
children	Array (of) $REF: SamplingHeapProfileNode	Child nodes.	-

SamplingHeapProfileSample

Object

A single sample from a sampling profile.

PROPERTIES:

Name	Type	Description	Flags
size	Number	Allocation size in bytes attributed to the sample.	-
nodeId	Integer	Id of the corresponding profile tree node.	-
ordinal	Number	Time-ordered sample ordinal number. It is unique across all profiles retrieved between startSampling and stopSampling.	-

SamplingHeapProfile

Object

Sampling profile.

PROPERTIES:

Name	Type	Description	Flags
head	$REF: SamplingHeapProfileNode	-	-
samples	Array (of) $REF: SamplingHeapProfileSample	-	-

commands

Name

Description

Flags

addInspectedHeapObject

Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).

PARAMETERS:

Name	Type	Description	Flags
heapObjectId	$REF: HeapSnapshotObjectId	Heap snapshot object id to be accessible by means of $x command line API.	-

collectGarbage

disable

enable

getHeapObjectId

PARAMETERS:

Name	Type	Description	Flags
objectId	$REF: RunTime.RemoteObjectId	Identifier of the object to get heap object id for.	-

RETURNS:

Name	Type	Description	Flags
heapSnapshotObjectId	$REF: HeapSnapshotObjectId	Id of the heap snapshot object corresponding to the passed remote object id.	-

getObjectByHeapObjectId

PARAMETERS:

Name	Type	Description	Flags
objectId	$REF: HeapSnapshotObjectId	-	-
objectGroup	String	Symbolic group name that can be used to release multiple objects.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
result	$REF: RunTime.RemoteObject	Evaluation result.	-

getSamplingProfile

RETURNS:

Name	Type	Description	Flags
profile	$REF: SamplingHeapProfile	Return the sampling profile being collected.	-

startSampling

PARAMETERS:

Name	Type	Description	Flags
samplingInterval	Number	Average sample interval in bytes. Poisson distribution is used for the intervals. The default value is 32768 bytes.	[OPTIONAL]
includeObjectsCollectedByMajorGC	Boolean	By default, the sampling heap profiler reports only objects which are still alive when the profile is returned via getSamplingProfile or stopSampling, which is useful for determining what functions contribute the most to steady-state memory usage. This flag instructs the sampling heap profiler to also include information about objects discarded by major GC, which will show which functions cause large temporary memory usage or long GC pauses.	[OPTIONAL]
includeObjectsCollectedByMinorGC	Boolean	By default, the sampling heap profiler reports only objects which are still alive when the profile is returned via getSamplingProfile or stopSampling, which is useful for determining what functions contribute the most to steady-state memory usage. This flag instructs the sampling heap profiler to also include information about objects discarded by minor GC, which is useful when tuning a latency-sensitive application for minimal GC activity.	[OPTIONAL]

startTrackingHeapObjects

PARAMETERS:

Name	Type	Description	Flags
trackAllocations	Boolean	-	[OPTIONAL]

stopSampling

RETURNS:

Name	Type	Description	Flags
profile	$REF: SamplingHeapProfile	Recorded sampling heap profile.	-

stopTrackingHeapObjects

PARAMETERS:

Name	Type	Description	Flags
reportProgress	Boolean	If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken when the tracking is stopped.	[OPTIONAL]
treatGlobalObjectsAsRoots	Boolean	Deprecated in favor of `exposeInternals`.	[OPTIONAL] [DEPRECATED]
captureNumericValue	Boolean	If true, numerical values are included in the snapshot	[OPTIONAL]
exposeInternals	Boolean	If true, exposes internals of the snapshot.	[OPTIONAL] [EXPERIMENTAL]

takeHeapSnapshot

PARAMETERS:

Name	Type	Description	Flags
reportProgress	Boolean	If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken.	[OPTIONAL]
treatGlobalObjectsAsRoots	Boolean	If true, a raw snapshot without artificial roots will be generated. Deprecated in favor of `exposeInternals`.	[OPTIONAL] [DEPRECATED]
captureNumericValue	Boolean	If true, numerical values are included in the snapshot	[OPTIONAL]
exposeInternals	Boolean	If true, exposes internals of the snapshot.	[OPTIONAL] [EXPERIMENTAL]

events

Name

Description

Flags

addHeapSnapshotChunk

PARAMETERS:

Name	Type	Description	Flags
chunk	String	-	-

heapStatsUpdate

If heap objects tracking has been started then backend may send update for one or more fragments

PARAMETERS:

Name	Type	Description	Flags
statsUpdate	Array (of) Integer	An array of triplets. Each triplet describes a fragment. The first integer is the fragment index, the second integer is a total count of objects for the fragment, the third integer is a total size of the objects for the fragment.	-

lastSeenObjectId

If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.

PARAMETERS:

Name	Type	Description	Flags
lastSeenObjectId	Integer	-	-
timestamp	Number	-	-

reportHeapSnapshotProgress

PARAMETERS:

Name	Type	Description	Flags
done	Integer	-	-
total	Integer	-	-
finished	Boolean	-	[OPTIONAL]

resetProfiles

Profiler

-

Dependencies: RunTime, Debugger

types

Type ID

Type

Description

Flags

ProfileNode

Object

Profile node. Holds callsite information, execution statistics and child nodes.

PROPERTIES:

Name	Type	Description	Flags
id	Integer	Unique id of the node.	-
callFrame	$REF: RunTime.CallFrame	Function location.	-
hitCount	Integer	Number of samples where this node was on top of the call stack.	[OPTIONAL]
children	Array (of) Integer	Child node ids.	[OPTIONAL]
deoptReason	String	The reason of being not optimized. The function may be deoptimized or marked as don't optimize.	[OPTIONAL]
positionTicks	Array (of) $REF: PositionTickInfo	An array of source position ticks.	[OPTIONAL]

Profile

Object

Profile.

PROPERTIES:

Name	Type	Description	Flags
nodes	Array (of) $REF: ProfileNode	The list of profile nodes. First item is the root node.	-
startTime	Number	Profiling start timestamp in microseconds.	-
endTime	Number	Profiling end timestamp in microseconds.	-
samples	Array (of) Integer	Ids of samples top nodes.	[OPTIONAL]
timeDeltas	Array (of) Integer	Time intervals between adjacent samples in microseconds. The first delta is relative to the profile startTime.	[OPTIONAL]

PositionTickInfo

Object

Specifies a number of samples attributed to a certain source position.

PROPERTIES:

Name	Type	Description	Flags
line	Integer	Source line number (1-based).	-
ticks	Integer	Number of samples attributed to the source line.	-

CoverageRange

Object

Coverage data for a source range.

PROPERTIES:

Name	Type	Description	Flags
startOffset	Integer	JavaScript script source offset for the range start.	-
endOffset	Integer	JavaScript script source offset for the range end.	-
count	Integer	Collected execution count of the source range.	-

FunctionCoverage

Object

Coverage data for a JavaScript function.

PROPERTIES:

Name	Type	Description	Flags
functionName	String	JavaScript function name.	-
ranges	Array (of) $REF: CoverageRange	Source ranges inside the function with coverage data.	-
isBlockCoverage	Boolean	Whether coverage data for this function has block granularity.	-

ScriptCoverage

Object

Coverage data for a JavaScript script.

PROPERTIES:

Name	Type	Description	Flags
scriptId	$REF: RunTime.ScriptId	JavaScript script id.	-
url	String	JavaScript script name or url.	-
functions	Array (of) $REF: FunctionCoverage	Functions contained in the script that has coverage data.	-

commands

Name

Description

Flags

disable

enable

getBestEffortCoverage

Collect coverage data for the current isolate. The coverage data may be incomplete due to garbage collection.

RETURNS:

Name	Type	Description	Flags
result	Array (of) $REF: ScriptCoverage	Coverage data for the current isolate.	-

setSamplingInterval

Changes CPU profiler sampling interval. Must be called before CPU profiles recording started.

PARAMETERS:

Name	Type	Description	Flags
interval	Integer	New sampling interval in microseconds.	-

start

startPreciseCoverage

Enable precise code coverage. Coverage data for JavaScript executed before enabling precise code coverage may be incomplete. Enabling prevents running optimized code and resets execution counters.

PARAMETERS:

Name	Type	Description	Flags
callCount	Boolean	Collect accurate call counts beyond simple 'covered' or 'not covered'.	[OPTIONAL]
detailed	Boolean	Collect block-based coverage.	[OPTIONAL]
allowTriggeredUpdates	Boolean	Allow the backend to send updates on its own initiative	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
timestamp	Number	Monotonically increasing time (in seconds) when the coverage update was taken in the backend.	-

stop

RETURNS:

Name	Type	Description	Flags
profile	$REF: Profile	Recorded profile.	-

stopPreciseCoverage

Disable precise code coverage. Disabling releases unnecessary execution count records and allows executing optimized code.

takePreciseCoverage

Collect coverage data for the current isolate, and resets execution counters. Precise code coverage needs to have started.

RETURNS:

Name	Type	Description	Flags
result	Array (of) $REF: ScriptCoverage	Coverage data for the current isolate.	-
timestamp	Number	Monotonically increasing time (in seconds) when the coverage update was taken in the backend.	-

events

Name

Description

Flags

consoleProfileFinished

PARAMETERS:

Name	Type	Description	Flags
id	String	-	-
location	$REF: Debugger.Location	Location of console.profileEnd().	-
profile	$REF: Profile	-	-
title	String	Profile title passed as an argument to console.profile().	[OPTIONAL]

consoleProfileStarted

Sent when new profile recording is started using console.profile() call.

PARAMETERS:

Name	Type	Description	Flags
id	String	-	-
location	$REF: Debugger.Location	Location of console.profile().	-
title	String	Profile title passed as an argument to console.profile().	[OPTIONAL]

preciseCoverageDeltaUpdate

Reports coverage delta since the last poll (either from an event like this, or from `takePreciseCoverage` for the current isolate. May only be sent if precise code coverage has been started. This event can be trigged by the embedder to, for example, trigger collection of coverage data immediately at a certain point in time.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
timestamp	Number	Monotonically increasing time (in seconds) when the coverage update was taken in the backend.	-
occasion	String	Identifier for distinguishing coverage events.	-
result	Array (of) $REF: ScriptCoverage	Coverage data for the current isolate.	-

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.

types

Type ID

Type

Description

Flags

ScriptId

String

Unique script identifier.

SerializationOptions

Object

Represents options for serialization. Overrides `generatePreview` and `returnByValue`.

PROPERTIES:

Name	Type	Description	Flags
serialization	"deep", "json", "idOnly"String [Hover] Enum	-	-
maxDepth	Integer	Deep serialization depth. Default is full depth. Respected only in `deep` serialization mode.	[OPTIONAL]
additionalParameters	Object	Embedder-specific parameters. For example if connected to V8 in Chrome these control DOM serialization via `maxNodeDepth: integer` and `includeShadowTree: "none" \| "open" \| "all"`. Values can be only of type string or integer.	[OPTIONAL]

DeepSerializedValue

Object

Represents deep serialized value.

PROPERTIES:

Name	Type	Description	Flags
type	"undefined", "null", "string", "number", "boolean", "bigint", "regexp", "date", "symbol", "array", "object", "function", "map", "set", "weakmap", "weakset", "error", "proxy", "promise", "typedarray", "arraybuffer", "node", "window", "generator"String [Hover] Enum	-	-
value	Any	-	[OPTIONAL]
objectId	String	-	[OPTIONAL]
weakLocalObjectReference	Integer	Set if value reference met more then once during serialization. In such case, value is provided only to one of the serialized values. Unique per value in the scope of one CDP call.	[OPTIONAL]

RemoteObjectId

String

Unique object identifier.

UnserializableValue

String

Primitive value which cannot be JSON-stringified. Includes values `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.

RemoteObject

Object

Mirror object referencing original JavaScript object.

PROPERTIES:

Name	Type	Description	Flags
type	"object", "function", "undefined", "string", "number", "boolean", "symbol", "bigint"String [Hover] Enum	Object type.	-
subtype	"array", "null", "node", "regexp", "date", "map", "set", "weakmap", "weakset", "iterator", "generator", "error", "proxy", "promise", "typedarray", "arraybuffer", "dataview", "webassemblymemory", "wasmvalue"String [Hover] Enum	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.	[OPTIONAL]
className	String	Object class (constructor) name. Specified for `object` type values only.	[OPTIONAL]
value	Any	Remote object value in case of primitive values or JSON values (if it was requested).	[OPTIONAL]
unserializableValue	$REF: UnserializableValue	Primitive value which can not be JSON-stringified does not have `value`, but gets this property.	[OPTIONAL]
description	String	String representation of the object.	[OPTIONAL]
deepSerializedValue	$REF: DeepSerializedValue	Deep serialized value.	[OPTIONAL] [EXPERIMENTAL]
objectId	$REF: RemoteObjectId	Unique object identifier (for non-primitive values).	[OPTIONAL]
preview	$REF: ObjectPreview	Preview containing abbreviated property values. Specified for `object` type values only.	[OPTIONAL] [EXPERIMENTAL]
customPreview	$REF: CustomPreview	-	[OPTIONAL] [EXPERIMENTAL]

CustomPreview

Object

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
header	String	The JSON-stringified result of formatter.header(object, config) call. It contains json ML array that represents RemoteObject.	-
bodyGetterId	$REF: RemoteObjectId	If formatter returns true as a result of formatter.hasBody call then bodyGetterId will contain RemoteObjectId for the function that returns result of formatter.body(object, config) call. The result value is json ML array.	[OPTIONAL]

ObjectPreview

Object

Object containing abbreviated remote object value.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
type	"object", "function", "undefined", "string", "number", "boolean", "symbol", "bigint"String [Hover] Enum	Object type.	-
subtype	"array", "null", "node", "regexp", "date", "map", "set", "weakmap", "weakset", "iterator", "generator", "error", "proxy", "promise", "typedarray", "arraybuffer", "dataview", "webassemblymemory", "wasmvalue"String [Hover] Enum	Object subtype hint. Specified for `object` type values only.	[OPTIONAL]
description	String	String representation of the object.	[OPTIONAL]
overflow	Boolean	True iff some of the properties or entries of the original object did not fit.	-
properties	Array (of) $REF: PropertyPreview	List of the properties.	-
entries	Array (of) $REF: EntryPreview	List of the entries. Specified for `map` and `set` subtype values only.	[OPTIONAL]

PropertyPreview

Object

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	String	Property name.	-
type	"object", "function", "undefined", "string", "number", "boolean", "symbol", "accessor", "bigint"String [Hover] Enum	Object type. Accessor means that the property itself is an accessor property.	-
value	String	User-friendly property value string.	[OPTIONAL]
valuePreview	$REF: ObjectPreview	Nested value preview.	[OPTIONAL]
subtype	"array", "null", "node", "regexp", "date", "map", "set", "weakmap", "weakset", "iterator", "generator", "error", "proxy", "promise", "typedarray", "arraybuffer", "dataview", "webassemblymemory", "wasmvalue"String [Hover] Enum	Object subtype hint. Specified for `object` type values only.	[OPTIONAL]

EntryPreview

Object

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
key	$REF: ObjectPreview	Preview of the key. Specified for map-like collection entries.	[OPTIONAL]
value	$REF: ObjectPreview	Preview of the value.	-

PropertyDescriptor

Object

Object property descriptor.

PROPERTIES:

Name	Type	Description	Flags
name	String	Property name or symbol description.	-
value	$REF: RemoteObject	The value associated with the property.	[OPTIONAL]
writable	Boolean	True if the value associated with the property may be changed (data descriptors only).	[OPTIONAL]
get	$REF: RemoteObject	A function which serves as a getter for the property, or `undefined` if there is no getter (accessor descriptors only).	[OPTIONAL]
set	$REF: RemoteObject	A function which serves as a setter for the property, or `undefined` if there is no setter (accessor descriptors only).	[OPTIONAL]
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.	[OPTIONAL]
isOwn	Boolean	True if the property is owned for the object.	[OPTIONAL]
symbol	$REF: RemoteObject	Property symbol object, if the property is of the `symbol` type.	[OPTIONAL]

InternalPropertyDescriptor

Object

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

PROPERTIES:

Name	Type	Description	Flags
name	String	Conventional property name.	-
value	$REF: RemoteObject	The value associated with the property.	[OPTIONAL]

PrivatePropertyDescriptor

Object

Object private field descriptor.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	String	Private property name.	-
value	$REF: RemoteObject	The value associated with the private property.	[OPTIONAL]
get	$REF: RemoteObject	A function which serves as a getter for the private property, or `undefined` if there is no getter (accessor descriptors only).	[OPTIONAL]
set	$REF: RemoteObject	A function which serves as a setter for the private property, or `undefined` if there is no setter (accessor descriptors only).	[OPTIONAL]

CallArgument

Object

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

PROPERTIES:

Name	Type	Description	Flags
value	Any	Primitive value or serializable javascript object.	[OPTIONAL]
unserializableValue	$REF: UnserializableValue	Primitive value which can not be JSON-stringified.	[OPTIONAL]
objectId	$REF: RemoteObjectId	Remote object handle.	[OPTIONAL]

ExecutionContextId

Integer

Id of an execution context.

ExecutionContextDescription

Object

Description of an isolated world.

PROPERTIES:

Name	Type	Description	Flags
id	$REF: 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.	-
uniqueId	String	A system-unique execution context identifier. Unlike the id, this is unique across multiple processes, so can be reliably used to identify specific context while backend performs a cross-process navigation.	[EXPERIMENTAL]
auxData	Object	Embedder-specific auxiliary data likely matching {isDefault: boolean, type: 'default'\|'isolated'\|'worker', frameId: string}	[OPTIONAL]

ExceptionDetails

Object

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

PROPERTIES:

Name	Type	Description	Flags
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	$REF: ScriptId	Script ID of the exception location.	[OPTIONAL]
url	String	URL of the exception location, to be used when the script was not reported.	[OPTIONAL]
stackTrace	$REF: StackTrace	JavaScript stack trace if available.	[OPTIONAL]
exception	$REF: RemoteObject	Exception object if available.	[OPTIONAL]
executionContextId	$REF: ExecutionContextId	Identifier of the context where exception happened.	[OPTIONAL]
exceptionMetaData	Object	Dictionary with entries of meta data that the client associated with this exception, such as information about associated network requests, etc.	[OPTIONAL] [EXPERIMENTAL]

Timestamp

Number

Number of milliseconds since epoch.

TimeDelta

Number

Number of milliseconds.

CallFrame

Object

Stack entry for runtime errors and assertions.

PROPERTIES:

Name	Type	Description	Flags
functionName	String	JavaScript function name.	-
scriptId	$REF: 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

Object

Call frames for assertions or error messages.

PROPERTIES:

Name	Type	Description	Flags
description	String	String label of this stack trace. For async traces this may be a name of the function that initiated the async call.	[OPTIONAL]
callFrames	Array (of) $REF: CallFrame	JavaScript function name.	-
parent	$REF: StackTrace	Asynchronous JavaScript stack trace that preceded this stack, if available.	[OPTIONAL]
parentId	$REF: StackTraceId	Asynchronous JavaScript stack trace that preceded this stack, if available.	[OPTIONAL] [EXPERIMENTAL]

UniqueDebuggerId

String

Unique identifier of current debugger.

[EXPERIMENTAL]

StackTraceId

Object

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.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
id	String	-	-
debuggerId	$REF: UniqueDebuggerId	-	[OPTIONAL]

commands

Name

Description

Flags

awaitPromise

Add handler to promise with given promise object id.

PARAMETERS:

Name	Type	Description	Flags
promiseObjectId	$REF: RemoteObjectId	Identifier of the promise.	-
returnByValue	Boolean	Whether the result is expected to be a JSON object that should be sent by value.	[OPTIONAL]
generatePreview	Boolean	Whether preview should be generated for the result.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
result	$REF: RemoteObject	Promise result. Will contain rejected value if promise was rejected.	-
exceptionDetails	$REF: ExceptionDetails	Exception details if stack strace is available.	[OPTIONAL]

callFunctionOn

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

PARAMETERS:

Name	Type	Description	Flags
functionDeclaration	String	Declaration of the function to call.	-
objectId	$REF: RemoteObjectId	Identifier of the object to call function on. Either objectId or executionContextId should be specified.	[OPTIONAL]
arguments	Array (of) $REF: CallArgument	Call arguments. All call arguments must belong to the same JavaScript world as the target object.	[OPTIONAL]
silent	Boolean	In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides `setPauseOnException` state.	[OPTIONAL]
returnByValue	Boolean	Whether the result is expected to be a JSON object which should be sent by value. Can be overriden by `serializationOptions`.	[OPTIONAL]
generatePreview	Boolean	Whether preview should be generated for the result.	[OPTIONAL] [EXPERIMENTAL]
userGesture	Boolean	Whether execution should be treated as initiated by user in the UI.	[OPTIONAL]
awaitPromise	Boolean	Whether execution should `await` for resulting value and return once awaited promise is resolved.	[OPTIONAL]
executionContextId	$REF: ExecutionContextId	Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified.	[OPTIONAL]
objectGroup	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.	[OPTIONAL]
throwOnSideEffect	Boolean	Whether to throw an exception if side effect cannot be ruled out during evaluation.	[OPTIONAL] [EXPERIMENTAL]
uniqueContextId	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`.	[OPTIONAL] [EXPERIMENTAL]
serializationOptions	$REF: SerializationOptions	Specifies the result serialization. If provided, overrides `generatePreview` and `returnByValue`.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
result	$REF: RemoteObject	Call result.	-
exceptionDetails	$REF: ExceptionDetails	Exception details.	[OPTIONAL]

compileScript

Compiles expression.

PARAMETERS:

Name	Type	Description	Flags
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	$REF: 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.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
scriptId	$REF: ScriptId	Id of the script.	[OPTIONAL]
exceptionDetails	$REF: ExceptionDetails	Exception details.	[OPTIONAL]

disable

Disables reporting of execution contexts creation.

discardConsoleEntries

Discards collected exceptions and console API calls.

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.

evaluate

Evaluates expression on global object.

PARAMETERS:

Name	Type	Description	Flags
expression	String	Expression to evaluate.	-
objectGroup	String	Symbolic group name that can be used to release multiple objects.	[OPTIONAL]
includeCommandLineAPI	Boolean	Determines whether Command Line API should be available during the evaluation.	[OPTIONAL]
silent	Boolean	In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides `setPauseOnException` state.	[OPTIONAL]
contextId	$REF: 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. 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.	[OPTIONAL]
returnByValue	Boolean	Whether the result is expected to be a JSON object that should be sent by value.	[OPTIONAL]
generatePreview	Boolean	Whether preview should be generated for the result.	[OPTIONAL] [EXPERIMENTAL]
userGesture	Boolean	Whether execution should be treated as initiated by user in the UI.	[OPTIONAL]
awaitPromise	Boolean	Whether execution should `await` for resulting value and return once awaited promise is resolved.	[OPTIONAL]
throwOnSideEffect	Boolean	Whether to throw an exception if side effect cannot be ruled out during evaluation. This implies `disableBreaks` below.	[OPTIONAL] [EXPERIMENTAL]
timeout	$REF: TimeDelta	Terminate execution after timing out (number of milliseconds).	[OPTIONAL] [EXPERIMENTAL]
disableBreaks	Boolean	Disable breakpoints during execution.	[OPTIONAL] [EXPERIMENTAL]
replMode	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.	[OPTIONAL] [EXPERIMENTAL]
allowUnsafeEvalBlockedByCSP	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.	[OPTIONAL] [EXPERIMENTAL]
uniqueContextId	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`.	[OPTIONAL] [EXPERIMENTAL]
serializationOptions	$REF: SerializationOptions	Specifies the result serialization. If provided, overrides `generatePreview` and `returnByValue`.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
result	$REF: RemoteObject	Evaluation result.	-
exceptionDetails	$REF: ExceptionDetails	Exception details.	[OPTIONAL]

getIsolateId

Returns the isolate id.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
id	String	The isolate id.	-

getHeapUsage

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

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
usedSize	Number	Used JavaScript heap size in bytes.	-
totalSize	Number	Allocated JavaScript heap size in bytes.	-
embedderHeapUsedSize	Number	Used size in bytes in the embedder's garbage-collected heap.	-
backingStorageSize	Number	Size in bytes of backing storage for array buffers and external strings.	-

getProperties

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

PARAMETERS:

Name	Type	Description	Flags
objectId	$REF: 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.	[OPTIONAL]
accessorPropertiesOnly	Boolean	If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.	[OPTIONAL] [EXPERIMENTAL]
generatePreview	Boolean	Whether preview should be generated for the results.	[OPTIONAL] [EXPERIMENTAL]
nonIndexedPropertiesOnly	Boolean	If true, returns non-indexed properties only.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
result	Array (of) $REF: PropertyDescriptor	Object properties.	-
internalProperties	Array (of) $REF: InternalPropertyDescriptor	Internal object properties (only of the element itself).	[OPTIONAL]
privateProperties	Array (of) $REF: PrivatePropertyDescriptor	Object private properties.	[OPTIONAL] [EXPERIMENTAL]
exceptionDetails	$REF: ExceptionDetails	Exception details.	[OPTIONAL]

globalLexicalScopeNames

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

PARAMETERS:

Name	Type	Description	Flags
executionContextId	$REF: ExecutionContextId	Specifies in which execution context to lookup global scope variables.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
names	Array (of) String	-	-

queryObjects

PARAMETERS:

Name	Type	Description	Flags
prototypeObjectId	$REF: RemoteObjectId	Identifier of the prototype to return objects for.	-
objectGroup	String	Symbolic group name that can be used to release the results.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
objects	$REF: RemoteObject	Array with objects.	-

releaseObject

Releases remote object with given id.

PARAMETERS:

Name	Type	Description	Flags
objectId	$REF: RemoteObjectId	Identifier of the object to release.	-

releaseObjectGroup

Releases all remote objects that belong to a given group.

PARAMETERS:

Name	Type	Description	Flags
objectGroup	String	Symbolic object group name.	-

runIfWaitingForDebugger

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

runScript

Runs script with given id in a given context.

PARAMETERS:

Name	Type	Description	Flags
scriptId	$REF: ScriptId	Id of the script to run.	-
executionContextId	$REF: 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.	[OPTIONAL]
objectGroup	String	Symbolic group name that can be used to release multiple objects.	[OPTIONAL]
silent	Boolean	In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides `setPauseOnException` state.	[OPTIONAL]
includeCommandLineAPI	Boolean	Determines whether Command Line API should be available during the evaluation.	[OPTIONAL]
returnByValue	Boolean	Whether the result is expected to be a JSON object which should be sent by value.	[OPTIONAL]
generatePreview	Boolean	Whether preview should be generated for the result.	[OPTIONAL]
awaitPromise	Boolean	Whether execution should `await` for resulting value and return once awaited promise is resolved.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
result	$REF: RemoteObject	Run result.	-
exceptionDetails	$REF: ExceptionDetails	Exception details.	[OPTIONAL]

setAsyncCallStackDepth
REDIRECT: Debugger

Enables or disables async call stacks tracking.

PARAMETERS:

Name	Type	Description	Flags
maxDepth	Integer	Maximum depth of async call stacks. Setting to `0` will effectively disable collecting async call stacks (default).	-

setCustomObjectFormatterEnabled

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	-	-

setMaxCallStackSizeToCapture

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
size	Integer	-	-

terminateExecution

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

[EXPERIMENTAL]

addBinding

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.

PARAMETERS:

Name	Type	Description	Flags
name	String	-	-
executionContextId	$REF: ExecutionContextId	If specified, the binding would only be exposed to the specified execution context. If omitted and `executionContextName` is not set, the binding is exposed to all execution contexts of the target. This parameter is mutually exclusive with `executionContextName`. Deprecated in favor of `executionContextName` due to an unclear use case and bugs in implementation (crbug.com/1169639). `executionContextId` will be removed in the future.	[OPTIONAL] [EXPERIMENTAL] [DEPRECATED]
executionContextName	String	If specified, the binding is exposed to the executionContext with matching name, even for contexts created after the binding is added. See also `ExecutionContext.name` and `worldName` parameter to `Page.addScriptToEvaluateOnNewDocument`. This parameter is mutually exclusive with `executionContextId`.	[OPTIONAL]

removeBinding

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

PARAMETERS:

Name	Type	Description	Flags
name	String	-	-

getExceptionDetails

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.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
errorObjectId	$REF: RemoteObjectId	The error object for which to resolve the exception details.	-

RETURNS:

Name	Type	Description	Flags
exceptionDetails	$REF: ExceptionDetails	-	[OPTIONAL]

events

Name

Description

Flags

bindingCalled

Notification is issued every time when binding is called.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
name	String	-	-
payload	String	-	-
executionContextId	$REF: ExecutionContextId	Identifier of the context where the call was made.	-

consoleAPICalled

Issued when console API was called.

PARAMETERS:

Name	Type	Description	Flags
type	"log", "debug", "info", "error", "warning", "dir", "dirxml", "table", "trace", "clear", "startGroup", "startGroupCollapsed", "endGroup", "assert", "profile", "profileEnd", "count", "timeEnd"String [Hover] Enum	Type of the call.	-
args	Array (of) $REF: RemoteObject	Call arguments.	-
executionContextId	$REF: ExecutionContextId	Identifier of the context where the call was made.	-
timestamp	$REF: Timestamp	Call timestamp.	-
stackTrace	$REF: StackTrace	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.	[OPTIONAL]
context	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.	[OPTIONAL] [EXPERIMENTAL]

exceptionRevoked

Issued when unhandled exception was revoked.

PARAMETERS:

Name	Type	Description	Flags
reason	String	Reason describing why exception was revoked.	-
exceptionId	Integer	The id of revoked exception, as reported in `exceptionThrown`.	-

exceptionThrown

Issued when exception was thrown and unhandled.

PARAMETERS:

Name	Type	Description	Flags
timestamp	$REF: Timestamp	Timestamp of the exception.	-
exceptionDetails	$REF: ExceptionDetails	-	-

executionContextCreated

Issued when new execution context is created.

PARAMETERS:

Name	Type	Description	Flags
context	$REF: ExecutionContextDescription	A newly created execution context.	-

executionContextDestroyed

Issued when execution context is destroyed.

PARAMETERS:

Name	Type	Description	Flags
executionContextId	$REF: ExecutionContextId	Id of the destroyed context	[DEPRECATED]
executionContextUniqueId	String	Unique Id of the destroyed context	[EXPERIMENTAL]

executionContextsCleared

Issued when all executionContexts were cleared in browser

inspectRequested

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

PARAMETERS:

Name	Type	Description	Flags
object	$REF: RemoteObject	-	-
hints	Object	-	-
executionContextId	$REF: ExecutionContextId	Identifier of the context where the call was made.	[OPTIONAL] [EXPERIMENTAL]

Available JavaScriptAPI Domains

Console

types

commands

events

Debugger

types

commands

events

HeapProfiler

types

commands

events

Profiler

types

commands

events

RunTime

types

commands

events

Schema

types

commands