| OLD | NEW |
|---|
| (Empty) | |
| 1 { |
| 2 "version": { "major": "1", "minor": "1" }, |
| 3 "domains": [{ |
| 4 "domain": "Runtime", |
| 5 "description": "Runtime domain exposes JavaScript runtime by means of re
mote evaluation and mirror objects. Evaluation results are returned as mirror ob
ject that expose object type, string representation and unique identifier that c
an be used for further object reference. Original objects are maintained in memo
ry unless they are either explicitly released or are released along with the oth
er objects in their object group.", |
| 6 "types": [ |
| 7 { |
| 8 "id": "ScriptId", |
| 9 "type": "string", |
| 10 "description": "Unique script identifier." |
| 11 }, |
| 12 { |
| 13 "id": "RemoteObjectId", |
| 14 "type": "string", |
| 15 "description": "Unique object identifier." |
| 16 }, |
| 17 { |
| 18 "id": "RemoteObject", |
| 19 "type": "object", |
| 20 "description": "Mirror object referencing original JavaScript ob
ject.", |
| 21 "properties": [ |
| 22 { "name": "type", "type": "string", "enum": ["object", "func
tion", "undefined", "string", "number", "boolean", "symbol"], "description": "Ob
ject type." }, |
| 23 { "name": "subtype", "type": "string", "optional": true, "en
um": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "gene
rator", "error"], "description": "Object subtype hint. Specified for <code>objec
t</code> type values only." }, |
| 24 { "name": "className", "type": "string", "optional": true, "
description": "Object class (constructor) name. Specified for <code>object</code
> type values only." }, |
| 25 { "name": "value", "type": "any", "optional": true, "descrip
tion": "Remote object value in case of primitive values or JSON values (if it wa
s requested), or description string if the value can not be JSON-stringified (li
ke NaN, Infinity, -Infinity, -0)." }, |
| 26 { "name": "description", "type": "string", "optional": true,
"description": "String representation of the object." }, |
| 27 { "name": "objectId", "$ref": "RemoteObjectId", "optional":
true, "description": "Unique object identifier (for non-primitive values)." }, |
| 28 { "name": "preview", "$ref": "ObjectPreview", "optional": tr
ue, "description": "Preview containing abbreviated property values. Specified fo
r <code>object</code> type values only.", "hidden": true }, |
| 29 { "name": "customPreview", "$ref": "CustomPreview", "optiona
l": true, "hidden": true} |
| 30 ] |
| 31 }, |
| 32 { |
| 33 "id": "CustomPreview", |
| 34 "type": "object", |
| 35 "hidden": true, |
| 36 "properties": [ |
| 37 { "name": "header", "type": "string"}, |
| 38 { "name": "hasBody", "type": "boolean"}, |
| 39 { "name": "formatterObjectId", "$ref": "RemoteObjectId"}, |
| 40 { "name": "bindRemoteObjectFunctionId", "$ref": "RemoteObjec
tId" }, |
| 41 { "name": "configObjectId", "$ref": "RemoteObjectId", "optio
nal": true } |
| 42 ] |
| 43 }, |
| 44 { |
| 45 "id": "ObjectPreview", |
| 46 "type": "object", |
| 47 "hidden": true, |
| 48 "description": "Object containing abbreviated remote object valu
e.", |
| 49 "properties": [ |
| 50 { "name": "type", "type": "string", "enum": ["object", "func
tion", "undefined", "string", "number", "boolean", "symbol"], "description": "Ob
ject type." }, |
| 51 { "name": "subtype", "type": "string", "optional": true, "en
um": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "gene
rator", "error"], "description": "Object subtype hint. Specified for <code>objec
t</code> type values only." }, |
| 52 { "name": "description", "type": "string", "optional": true,
"description": "String representation of the object." }, |
| 53 { "name": "overflow", "type": "boolean", "description": "Tru
e iff some of the properties or entries of the original object did not fit." }, |
| 54 { "name": "properties", "type": "array", "items": { "$ref":
"PropertyPreview" }, "description": "List of the properties." }, |
| 55 { "name": "entries", "type": "array", "items": { "$ref": "En
tryPreview" }, "optional": true, "description": "List of the entries. Specified
for <code>map</code> and <code>set</code> subtype values only." } |
| 56 ] |
| 57 }, |
| 58 { |
| 59 "id": "PropertyPreview", |
| 60 "type": "object", |
| 61 "hidden": true, |
| 62 "properties": [ |
| 63 { "name": "name", "type": "string", "description": "Property
name." }, |
| 64 { "name": "type", "type": "string", "enum": ["object", "func
tion", "undefined", "string", "number", "boolean", "symbol", "accessor"], "descr
iption": "Object type. Accessor means that the property itself is an accessor pr
operty." }, |
| 65 { "name": "value", "type": "string", "optional": true, "desc
ription": "User-friendly property value string." }, |
| 66 { "name": "valuePreview", "$ref": "ObjectPreview", "optional
": true, "description": "Nested value preview." }, |
| 67 { "name": "subtype", "type": "string", "optional": true, "en
um": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "gene
rator", "error"], "description": "Object subtype hint. Specified for <code>objec
t</code> type values only." } |
| 68 ] |
| 69 }, |
| 70 { |
| 71 "id": "EntryPreview", |
| 72 "type": "object", |
| 73 "hidden": true, |
| 74 "properties": [ |
| 75 { "name": "key", "$ref": "ObjectPreview", "optional": true,
"description": "Preview of the key. Specified for map-like collection entries."
}, |
| 76 { "name": "value", "$ref": "ObjectPreview", "description": "
Preview of the value." } |
| 77 ] |
| 78 }, |
| 79 { |
| 80 "id": "PropertyDescriptor", |
| 81 "type": "object", |
| 82 "description": "Object property descriptor.", |
| 83 "properties": [ |
| 84 { "name": "name", "type": "string", "description": "Property
name or symbol description." }, |
| 85 { "name": "value", "$ref": "RemoteObject", "optional": true,
"description": "The value associated with the property." }, |
| 86 { "name": "writable", "type": "boolean", "optional": true, "
description": "True if the value associated with the property may be changed (da
ta descriptors only)." }, |
| 87 { "name": "get", "$ref": "RemoteObject", "optional": true, "
description": "A function which serves as a getter for the property, or <code>un
defined</code> if there is no getter (accessor descriptors only)." }, |
| 88 { "name": "set", "$ref": "RemoteObject", "optional": true, "
description": "A function which serves as a setter for the property, or <code>un
defined</code> if there is no setter (accessor descriptors only)." }, |
| 89 { "name": "configurable", "type": "boolean", "description":
"True if the type of this property descriptor may be changed and if the property
may be deleted from the corresponding object." }, |
| 90 { "name": "enumerable", "type": "boolean", "description": "T
rue if this property shows up during enumeration of the properties on the corres
ponding object." }, |
| 91 { "name": "wasThrown", "type": "boolean", "optional": true,
"description": "True if the result was thrown during the evaluation." }, |
| 92 { "name": "isOwn", "optional": true, "type": "boolean", "des
cription": "True if the property is owned for the object.", "hidden": true }, |
| 93 { "name": "symbol", "$ref": "RemoteObject", "optional": true
, "description": "Property symbol object, if the property is of the <code>symbol
</code> type.", "hidden": true } |
| 94 ] |
| 95 }, |
| 96 { |
| 97 "id": "InternalPropertyDescriptor", |
| 98 "type": "object", |
| 99 "description": "Object internal property descriptor. This proper
ty isn't normally visible in JavaScript code.", |
| 100 "properties": [ |
| 101 { "name": "name", "type": "string", "description": "Conventi
onal property name." }, |
| 102 { "name": "value", "$ref": "RemoteObject", "optional": true,
"description": "The value associated with the property." } |
| 103 ], |
| 104 "hidden": true |
| 105 }, |
| 106 { |
| 107 "id": "CallArgument", |
| 108 "type": "object", |
| 109 "description": "Represents function call argument. Either remote
object id <code>objectId</code> or primitive <code>value</code> or neither of (
for undefined) them should be specified.", |
| 110 "properties": [ |
| 111 { "name": "value", "type": "any", "optional": true, "descrip
tion": "Primitive value, or description string if the value can not be JSON-stri
ngified (like NaN, Infinity, -Infinity, -0)." }, |
| 112 { "name": "objectId", "$ref": "RemoteObjectId", "optional":
true, "description": "Remote object handle." }, |
| 113 { "name": "type", "optional": true, "hidden": true, "type":
"string", "enum": ["object", "function", "undefined", "string", "number", "boole
an", "symbol"], "description": "Object type." } |
| 114 ] |
| 115 }, |
| 116 { |
| 117 "id": "ExecutionContextId", |
| 118 "type": "integer", |
| 119 "description": "Id of an execution context." |
| 120 }, |
| 121 { |
| 122 "id": "ExecutionContextDescription", |
| 123 "type": "object", |
| 124 "description": "Description of an isolated world.", |
| 125 "properties": [ |
| 126 { "name": "id", "$ref": "ExecutionContextId", "description":
"Unique id of the execution context. It can be used to specify in which executi
on context script evaluation should be performed." }, |
| 127 { "name": "isDefault", "type": "boolean", "description": "Wh
ether context is the default page context (as opposite to e.g. context of conten
t script).", "hidden": true }, |
| 128 { "name": "origin", "type": "string", "description": "Execut
ion context origin.", "hidden": true}, |
| 129 { "name": "name", "type": "string", "description": "Human re
adable name describing given context.", "hidden": true}, |
| 130 { "name": "frameId", "type": "string", "description": "Id of
the owning frame. May be an empty string if the context is not associated with
a frame." } |
| 131 ] |
| 132 }, |
| 133 { |
| 134 "id": "ExceptionDetails", |
| 135 "type": "object", |
| 136 "description": "Detailed information on exception (or error) tha
t was thrown during script compilation or execution.", |
| 137 "properties": [ |
| 138 { "name": "text", "type": "string", "description": "Exceptio
n text." }, |
| 139 { "name": "url", "type": "string", "optional": true, "descri
ption": "URL of the message origin." }, |
| 140 { "name": "scriptId", "type": "string", "optional": true, "d
escription": "Script ID of the message origin." }, |
| 141 { "name": "line", "type": "integer", "optional": true, "desc
ription": "Line number in the resource that generated this message." }, |
| 142 { "name": "column", "type": "integer", "optional": true, "de
scription": "Column number in the resource that generated this message." }, |
| 143 { "name": "stack", "$ref": "StackTrace", "optional": true, "
description": "JavaScript stack trace for assertions and error messages." } |
| 144 ] |
| 145 }, |
| 146 { |
| 147 "id": "CallFrame", |
| 148 "type": "object", |
| 149 "description": "Stack entry for runtime errors and assertions.", |
| 150 "properties": [ |
| 151 { "name": "functionName", "type": "string", "description": "
JavaScript function name." }, |
| 152 { "name": "scriptId", "$ref": "ScriptId", "description": "Ja
vaScript script id." }, |
| 153 { "name": "url", "type": "string", "description": "JavaScrip
t script name or url." }, |
| 154 { "name": "lineNumber", "type": "integer", "description": "J
avaScript script line number." }, |
| 155 { "name": "columnNumber", "type": "integer", "description":
"JavaScript script column number." } |
| 156 ] |
| 157 }, |
| 158 { |
| 159 "id": "StackTrace", |
| 160 "type": "object", |
| 161 "description": "Call frames for assertions or error messages.", |
| 162 "properties": [ |
| 163 { "name": "description", "type": "string", "optional": true,
"description": "String label of this stack trace. For async traces this may be
a name of the function that initiated the async call." }, |
| 164 { "name": "callFrames", "type": "array", "items": { "$ref":
"CallFrame" }, "description": "JavaScript function name." }, |
| 165 { "name": "parent", "$ref": "StackTrace", "optional": true,
"hidden": true, "hidden": true, "description": "Asynchronous JavaScript stack tr
ace that preceded this stack, if available." } |
| 166 ] |
| 167 } |
| 168 ], |
| 169 "commands": [ |
| 170 { |
| 171 "name": "evaluate", |
| 172 "parameters": [ |
| 173 { "name": "expression", "type": "string", "description": "Ex
pression to evaluate." }, |
| 174 { "name": "objectGroup", "type": "string", "optional": true,
"description": "Symbolic group name that can be used to release multiple object
s." }, |
| 175 { "name": "includeCommandLineAPI", "type": "boolean", "optio
nal": true, "description": "Determines whether Command Line API should be availa
ble during the evaluation.", "hidden": true }, |
| 176 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "b
oolean", "optional": true, "description": "Specifies whether evaluation should s
top on exceptions and mute console. Overrides setPauseOnException state.", "hidd
en": true }, |
| 177 { "name": "contextId", "$ref": "ExecutionContextId", "option
al": true, "description": "Specifies in which isolated context to perform evalua
tion. Each content script lives in an isolated context and this parameter may be
used to specify one of those contexts. If the parameter is omitted or 0 the eva
luation will be performed in the context of the inspected page." }, |
| 178 { "name": "returnByValue", "type": "boolean", "optional": tr
ue, "description": "Whether the result is expected to be a JSON object that shou
ld be sent by value." }, |
| 179 { "name": "generatePreview", "type": "boolean", "optional":
true, "hidden": true, "description": "Whether preview should be generated for th
e result." }, |
| 180 { "name": "userGesture", "type": "boolean", "optional": true
, "hidden": true, "description": "Whether execution should be treated as initiat
ed by user in the UI." } |
| 181 ], |
| 182 "returns": [ |
| 183 { "name": "result", "$ref": "RemoteObject", "description": "
Evaluation result." }, |
| 184 { "name": "wasThrown", "type": "boolean", "optional": true,
"description": "True if the result was thrown during the evaluation." }, |
| 185 { "name": "exceptionDetails", "$ref": "ExceptionDetails", "o
ptional": true, "hidden": true, "description": "Exception details."} |
| 186 ], |
| 187 "description": "Evaluates expression on global object." |
| 188 }, |
| 189 { |
| 190 "name": "callFunctionOn", |
| 191 "parameters": [ |
| 192 { "name": "objectId", "$ref": "RemoteObjectId", "description
": "Identifier of the object to call function on." }, |
| 193 { "name": "functionDeclaration", "type": "string", "descript
ion": "Declaration of the function to call." }, |
| 194 { "name": "arguments", "type": "array", "items": { "$ref": "
CallArgument", "description": "Call argument." }, "optional": true, "description
": "Call arguments. All call arguments must belong to the same JavaScript world
as the target object." }, |
| 195 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "b
oolean", "optional": true, "description": "Specifies whether function call shoul
d stop on exceptions and mute console. Overrides setPauseOnException state.", "h
idden": true }, |
| 196 { "name": "returnByValue", "type": "boolean", "optional": tr
ue, "description": "Whether the result is expected to be a JSON object which sho
uld be sent by value." }, |
| 197 { "name": "generatePreview", "type": "boolean", "optional":
true, "hidden": true, "description": "Whether preview should be generated for th
e result." }, |
| 198 { "name": "userGesture", "type": "boolean", "optional": true
, "hidden": true, "description": "Whether execution should be treated as initiat
ed by user in the UI." } |
| 199 ], |
| 200 "returns": [ |
| 201 { "name": "result", "$ref": "RemoteObject", "description": "
Call result." }, |
| 202 { "name": "wasThrown", "type": "boolean", "optional": true,
"description": "True if the result was thrown during the evaluation." } |
| 203 ], |
| 204 "description": "Calls function with given declaration on the giv
en object. Object group of the result is inherited from the target object." |
| 205 }, |
| 206 { |
| 207 "name": "getProperties", |
| 208 "parameters": [ |
| 209 { "name": "objectId", "$ref": "RemoteObjectId", "description
": "Identifier of the object to return properties for." }, |
| 210 { "name": "ownProperties", "optional": true, "type": "boolea
n", "description": "If true, returns properties belonging only to the element it
self, not to its prototype chain." }, |
| 211 { "name": "accessorPropertiesOnly", "optional": true, "type"
: "boolean", "description": "If true, returns accessor properties (with getter/s
etter) only; internal properties are not returned either.", "hidden": true }, |
| 212 { "name": "generatePreview", "type": "boolean", "optional":
true, "hidden": true, "description": "Whether preview should be generated for th
e results." } |
| 213 ], |
| 214 "returns": [ |
| 215 { "name": "result", "type": "array", "items": { "$ref": "Pro
pertyDescriptor" }, "description": "Object properties." }, |
| 216 { "name": "internalProperties", "optional": true, "type": "a
rray", "items": { "$ref": "InternalPropertyDescriptor" }, "description": "Intern
al object properties (only of the element itself).", "hidden": true }, |
| 217 { "name": "exceptionDetails", "$ref": "ExceptionDetails", "o
ptional": true, "hidden": true, "description": "Exception details."} |
| 218 ], |
| 219 "description": "Returns properties of a given object. Object gro
up of the result is inherited from the target object." |
| 220 }, |
| 221 { |
| 222 "name": "releaseObject", |
| 223 "parameters": [ |
| 224 { "name": "objectId", "$ref": "RemoteObjectId", "description
": "Identifier of the object to release." } |
| 225 ], |
| 226 "description": "Releases remote object with given id." |
| 227 }, |
| 228 { |
| 229 "name": "releaseObjectGroup", |
| 230 "parameters": [ |
| 231 { "name": "objectGroup", "type": "string", "description": "S
ymbolic object group name." } |
| 232 ], |
| 233 "description": "Releases all remote objects that belong to a giv
en group." |
| 234 }, |
| 235 { |
| 236 "name": "run", |
| 237 "hidden": true, |
| 238 "description": "Tells inspected instance(worker or page) that it
can run in case it was started paused." |
| 239 }, |
| 240 { |
| 241 "name": "enable", |
| 242 "description": "Enables reporting of execution contexts creation
by means of <code>executionContextCreated</code> event. When the reporting gets
enabled the event will be sent immediately for each existing execution context.
" |
| 243 }, |
| 244 { |
| 245 "name": "disable", |
| 246 "hidden": true, |
| 247 "description": "Disables reporting of execution contexts creatio
n." |
| 248 }, |
| 249 { |
| 250 "name": "setCustomObjectFormatterEnabled", |
| 251 "parameters": [ |
| 252 { |
| 253 "name": "enabled", |
| 254 "type": "boolean" |
| 255 } |
| 256 ], |
| 257 "hidden": true |
| 258 }, |
| 259 { |
| 260 "name": "compileScript", |
| 261 "hidden": true, |
| 262 "parameters": [ |
| 263 { "name": "expression", "type": "string", "description": "Ex
pression to compile." }, |
| 264 { "name": "sourceURL", "type": "string", "description": "Sou
rce url to be set for the script." }, |
| 265 { "name": "persistScript", "type": "boolean", "description":
"Specifies whether the compiled script should be persisted." }, |
| 266 { "name": "executionContextId", "$ref": "ExecutionContextId"
, "description": "Specifies in which isolated context to perform script run. Eac
h content script lives in an isolated context and this parameter is used to spec
ify one of those contexts." } |
| 267 ], |
| 268 "returns": [ |
| 269 { "name": "scriptId", "$ref": "ScriptId", "optional": true,
"description": "Id of the script." }, |
| 270 { "name": "exceptionDetails", "$ref": "ExceptionDetails", "o
ptional": true, "description": "Exception details."} |
| 271 ], |
| 272 "description": "Compiles expression." |
| 273 }, |
| 274 { |
| 275 "name": "runScript", |
| 276 "hidden": true, |
| 277 "parameters": [ |
| 278 { "name": "scriptId", "$ref": "ScriptId", "description": "Id
of the script to run." }, |
| 279 { "name": "executionContextId", "$ref": "ExecutionContextId"
, "description": "Specifies in which isolated context to perform script run. Eac
h content script lives in an isolated context and this parameter is used to spec
ify one of those contexts." }, |
| 280 { "name": "objectGroup", "type": "string", "optional": true,
"description": "Symbolic group name that can be used to release multiple object
s." }, |
| 281 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "b
oolean", "optional": true, "description": "Specifies whether script run should s
top on exceptions and mute console. Overrides setPauseOnException state." }, |
| 282 { "name": "includeCommandLineAPI", "type": "boolean", "optio
nal": true, "description": "Determines whether Command Line API should be availa
ble during the evaluation." } |
| 283 ], |
| 284 "returns": [ |
| 285 { "name": "result", "$ref": "RemoteObject", "description": "
Run result." }, |
| 286 { "name": "exceptionDetails", "$ref": "ExceptionDetails", "o
ptional": true, "description": "Exception details."} |
| 287 ], |
| 288 "description": "Runs script with given id in a given context." |
| 289 } |
| 290 ], |
| 291 "events": [ |
| 292 { |
| 293 "name": "executionContextCreated", |
| 294 "parameters": [ |
| 295 { "name": "context", "$ref": "ExecutionContextDescription",
"description": "A newly created execution contex." } |
| 296 ], |
| 297 "description": "Issued when new execution context is created." |
| 298 }, |
| 299 { |
| 300 "name": "executionContextDestroyed", |
| 301 "parameters": [ |
| 302 { "name": "executionContextId", "$ref": "ExecutionContextId"
, "description": "Id of the destroyed context" } |
| 303 ], |
| 304 "description": "Issued when execution context is destroyed." |
| 305 }, |
| 306 { |
| 307 "name": "executionContextsCleared", |
| 308 "description": "Issued when all executionContexts were cleared i
n browser" |
| 309 }, |
| 310 { |
| 311 "name": "inspectRequested", |
| 312 "parameters": [ |
| 313 { "name": "object", "$ref": "RemoteObject" }, |
| 314 { "name": "hints", "type": "object" } |
| 315 ], |
| 316 "hidden": true |
| 317 } |
| 318 ] |
| 319 }, |
| 320 { |
| 321 "domain": "Debugger", |
| 322 "description": "Debugger domain exposes JavaScript debugging capabilitie
s. It allows setting and removing breakpoints, stepping through execution, explo
ring stack traces, etc.", |
| 323 "dependencies": ["Runtime"], |
| 324 "types": [ |
| 325 { |
| 326 "id": "BreakpointId", |
| 327 "type": "string", |
| 328 "description": "Breakpoint identifier." |
| 329 }, |
| 330 { |
| 331 "id": "CallFrameId", |
| 332 "type": "string", |
| 333 "description": "Call frame identifier." |
| 334 }, |
| 335 { |
| 336 "id": "Location", |
| 337 "type": "object", |
| 338 "properties": [ |
| 339 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti
on": "Script identifier as reported in the <code>Debugger.scriptParsed</code>."
}, |
| 340 { "name": "lineNumber", "type": "integer", "description": "L
ine number in the script (0-based)." }, |
| 341 { "name": "columnNumber", "type": "integer", "optional": tru
e, "description": "Column number in the script (0-based)." } |
| 342 ], |
| 343 "description": "Location in the source code." |
| 344 }, |
| 345 { |
| 346 "id": "ScriptPosition", |
| 347 "hidden": true, |
| 348 "type": "object", |
| 349 "properties": [ |
| 350 { "name": "line", "type": "integer" }, |
| 351 { "name": "column", "type": "integer" } |
| 352 ], |
| 353 "description": "Location in the source code." |
| 354 }, |
| 355 { |
| 356 "id": "FunctionDetails", |
| 357 "hidden": true, |
| 358 "type": "object", |
| 359 "properties": [ |
| 360 { "name": "location", "$ref": "Location", "optional": true,
"description": "Location of the function, none for native functions." }, |
| 361 { "name": "functionName", "type": "string", "description": "
Name of the function." }, |
| 362 { "name": "isGenerator", "type": "boolean", "description": "
Whether this is a generator function." }, |
| 363 { "name": "scopeChain", "type": "array", "optional": true, "
items": { "$ref": "Scope" }, "description": "Scope chain for this closure." } |
| 364 ], |
| 365 "description": "Information about the function." |
| 366 }, |
| 367 { |
| 368 "id": "GeneratorObjectDetails", |
| 369 "hidden": true, |
| 370 "type": "object", |
| 371 "properties": [ |
| 372 { "name": "function", "$ref": "Runtime.RemoteObject", "descr
iption": "Generator function." }, |
| 373 { "name": "functionName", "type": "string", "description": "
Name of the generator function." }, |
| 374 { "name": "status", "type": "string", "enum": ["running", "s
uspended", "closed"], "description": "Current generator object status." }, |
| 375 { "name": "location", "$ref": "Location", "optional": true,
"description": "If suspended, location where generator function was suspended (e
.g. location of the last 'yield'). Otherwise, location of the generator function
." } |
| 376 ], |
| 377 "description": "Information about the generator object." |
| 378 }, |
| 379 { |
| 380 "id": "CollectionEntry", |
| 381 "hidden": true, |
| 382 "type": "object", |
| 383 "properties": [ |
| 384 { "name": "key", "$ref": "Runtime.RemoteObject", "optional":
true, "description": "Entry key of a map-like collection, otherwise not provide
d." }, |
| 385 { "name": "value", "$ref": "Runtime.RemoteObject", "descript
ion": "Entry value." } |
| 386 ], |
| 387 "description": "Collection entry." |
| 388 }, |
| 389 { |
| 390 "id": "CallFrame", |
| 391 "type": "object", |
| 392 "properties": [ |
| 393 { "name": "callFrameId", "$ref": "CallFrameId", "description
": "Call frame identifier. This identifier is only valid while the virtual machi
ne is paused." }, |
| 394 { "name": "functionName", "type": "string", "description": "
Name of the JavaScript function called on this call frame." }, |
| 395 { "name": "functionLocation", "$ref": "Location", "optional"
: true, "hidden": true, "description": "Location in the source code." }, |
| 396 { "name": "location", "$ref": "Location", "description": "Lo
cation in the source code." }, |
| 397 { "name": "scopeChain", "type": "array", "items": { "$ref":
"Scope" }, "description": "Scope chain for this call frame." }, |
| 398 { "name": "this", "$ref": "Runtime.RemoteObject", "descripti
on": "<code>this</code> object for this call frame." }, |
| 399 { "name": "returnValue", "$ref": "Runtime.RemoteObject", "op
tional": true, "hidden": true, "description": "The value being returned, if the
function is at return point." } |
| 400 ], |
| 401 "description": "JavaScript call frame. Array of call frames form
the call stack." |
| 402 }, |
| 403 { |
| 404 "id": "Scope", |
| 405 "type": "object", |
| 406 "properties": [ |
| 407 { "name": "type", "type": "string", "enum": ["global", "loca
l", "with", "closure", "catch", "block", "script"], "description": "Scope type."
}, |
| 408 { "name": "object", "$ref": "Runtime.RemoteObject", "descrip
tion": "Object representing the scope. For <code>global</code> and <code>with</c
ode> scopes it represents the actual object; for the rest of the scopes, it is a
rtificial transient object enumerating scope variables as its properties." }, |
| 409 { "name": "name", "type": "string", "optional": true, "hidde
n": true }, |
| 410 { "name": "startLocation", "$ref": "Location", "optional": t
rue, "hidden": true, "description": "Location in the source code where scope sta
rts" }, |
| 411 { "name": "endLocation", "$ref": "Location", "optional": tru
e, "hidden": true, "description": "Location in the source code where scope ends"
} |
| 412 ], |
| 413 "description": "Scope description." |
| 414 }, |
| 415 { |
| 416 "id": "SetScriptSourceError", |
| 417 "type": "object", |
| 418 "properties": [ |
| 419 { "name": "message", "type": "string", "description": "Compi
ler error message" }, |
| 420 { "name": "lineNumber", "type": "integer", "description": "C
ompile error line number (1-based)" }, |
| 421 { "name": "columnNumber", "type": "integer", "description":
"Compile error column number (1-based)" } |
| 422 ], |
| 423 "description": "Error data for setScriptSource command. Contains
uncompilable script source error.", |
| 424 "hidden": true |
| 425 }, |
| 426 { |
| 427 "id": "SearchMatch", |
| 428 "type": "object", |
| 429 "description": "Search match for resource.", |
| 430 "properties": [ |
| 431 { "name": "lineNumber", "type": "number", "description": "Li
ne number in resource content." }, |
| 432 { "name": "lineContent", "type": "string", "description": "L
ine with match content." } |
| 433 ], |
| 434 "hidden": true |
| 435 } |
| 436 ], |
| 437 "commands": [ |
| 438 { |
| 439 "name": "enable", |
| 440 "description": "Enables debugger for the given page. Clients sho
uld not assume that the debugging has been enabled until the result for this com
mand is received." |
| 441 }, |
| 442 { |
| 443 "name": "disable", |
| 444 "description": "Disables debugger for given page." |
| 445 }, |
| 446 { |
| 447 "name": "setBreakpointsActive", |
| 448 "parameters": [ |
| 449 { "name": "active", "type": "boolean", "description": "New v
alue for breakpoints active state." } |
| 450 ], |
| 451 "description": "Activates / deactivates all breakpoints on the p
age." |
| 452 }, |
| 453 { |
| 454 "name": "setSkipAllPauses", |
| 455 "hidden": true, |
| 456 "parameters": [ |
| 457 { "name": "skipped", "type": "boolean", "description": "New
value for skip pauses state." } |
| 458 ], |
| 459 "description": "Makes page not interrupt on any pauses (breakpoi
nt, exception, dom exception etc)." |
| 460 }, |
| 461 { |
| 462 "name": "setBreakpointByUrl", |
| 463 "parameters": [ |
| 464 { "name": "lineNumber", "type": "integer", "description": "L
ine number to set breakpoint at." }, |
| 465 { "name": "url", "type": "string", "optional": true, "descri
ption": "URL of the resources to set breakpoint on." }, |
| 466 { "name": "urlRegex", "type": "string", "optional": true, "d
escription": "Regex pattern for the URLs of the resources to set breakpoints on.
Either <code>url</code> or <code>urlRegex</code> must be specified." }, |
| 467 { "name": "columnNumber", "type": "integer", "optional": tru
e, "description": "Offset in the line to set breakpoint at." }, |
| 468 { "name": "condition", "type": "string", "optional": true, "
description": "Expression to use as a breakpoint condition. When specified, debu
gger will only stop on the breakpoint if this expression evaluates to true." } |
| 469 ], |
| 470 "returns": [ |
| 471 { "name": "breakpointId", "$ref": "BreakpointId", "descripti
on": "Id of the created breakpoint for further reference." }, |
| 472 { "name": "locations", "type": "array", "items": { "$ref": "
Location" }, "description": "List of the locations this breakpoint resolved into
upon addition." } |
| 473 ], |
| 474 "description": "Sets JavaScript breakpoint at given location spe
cified either by URL or URL regex. Once this command is issued, all existing par
sed scripts will have breakpoints resolved and returned in <code>locations</code
> property. Further matching script parsing will result in subsequent <code>brea
kpointResolved</code> events issued. This logical breakpoint will survive page r
eloads." |
| 475 }, |
| 476 { |
| 477 "name": "setBreakpoint", |
| 478 "parameters": [ |
| 479 { "name": "location", "$ref": "Location", "description": "Lo
cation to set breakpoint in." }, |
| 480 { "name": "condition", "type": "string", "optional": true, "
description": "Expression to use as a breakpoint condition. When specified, debu
gger will only stop on the breakpoint if this expression evaluates to true." } |
| 481 ], |
| 482 "returns": [ |
| 483 { "name": "breakpointId", "$ref": "BreakpointId", "descripti
on": "Id of the created breakpoint for further reference." }, |
| 484 { "name": "actualLocation", "$ref": "Location", "description
": "Location this breakpoint resolved into." } |
| 485 ], |
| 486 "description": "Sets JavaScript breakpoint at a given location." |
| 487 }, |
| 488 { |
| 489 "name": "removeBreakpoint", |
| 490 "parameters": [ |
| 491 { "name": "breakpointId", "$ref": "BreakpointId" } |
| 492 ], |
| 493 "description": "Removes JavaScript breakpoint." |
| 494 }, |
| 495 { |
| 496 "name": "continueToLocation", |
| 497 "parameters": [ |
| 498 { "name": "location", "$ref": "Location", "description": "Lo
cation to continue to." }, |
| 499 { "name": "interstatementLocation", "type": "boolean", "opti
onal": true, "hidden": true, "description": "Allows breakpoints at the intemedia
te positions inside statements." } |
| 500 ], |
| 501 "description": "Continues execution until specific location is r
eached." |
| 502 }, |
| 503 { |
| 504 "name": "stepOver", |
| 505 "description": "Steps over the statement." |
| 506 }, |
| 507 { |
| 508 "name": "stepInto", |
| 509 "description": "Steps into the function call." |
| 510 }, |
| 511 { |
| 512 "name": "stepOut", |
| 513 "description": "Steps out of the function call." |
| 514 }, |
| 515 { |
| 516 "name": "pause", |
| 517 "description": "Stops on the next JavaScript statement." |
| 518 }, |
| 519 { |
| 520 "name": "resume", |
| 521 "description": "Resumes JavaScript execution." |
| 522 }, |
| 523 { |
| 524 "name": "searchInContent", |
| 525 "parameters": [ |
| 526 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti
on": "Id of the script to search in." }, |
| 527 { "name": "query", "type": "string", "description": "String
to search for." }, |
| 528 { "name": "caseSensitive", "type": "boolean", "optional": tr
ue, "description": "If true, search is case sensitive." }, |
| 529 { "name": "isRegex", "type": "boolean", "optional": true, "d
escription": "If true, treats string parameter as regex." } |
| 530 ], |
| 531 "returns": [ |
| 532 { "name": "result", "type": "array", "items": { "$ref": "Sea
rchMatch" }, "description": "List of search matches." } |
| 533 ], |
| 534 "description": "Searches for given string in script content." |
| 535 }, |
| 536 { |
| 537 "name": "canSetScriptSource", |
| 538 "returns": [ |
| 539 { "name": "result", "type": "boolean", "description": "True
if <code>setScriptSource</code> is supported." } |
| 540 ], |
| 541 "description": "Always returns true." |
| 542 }, |
| 543 { |
| 544 "name": "setScriptSource", |
| 545 "parameters": [ |
| 546 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti
on": "Id of the script to edit." }, |
| 547 { "name": "scriptSource", "type": "string", "description": "
New content of the script." }, |
| 548 { "name": "preview", "type": "boolean", "optional": true, "d
escription": " If true the change will not actually be applied. Preview mode may
be used to get result description without actually modifying the code.", "hidde
n": true } |
| 549 ], |
| 550 "returns": [ |
| 551 { "name": "callFrames", "type": "array", "optional": true, "
items": { "$ref": "CallFrame" }, "description": "New stack trace in case editing
has happened while VM was stopped." }, |
| 552 { "name": "stackChanged", "type": "boolean", "optional": tru
e, "description": "Whether current call stack was modified after applying the c
hanges.", "hidden": true }, |
| 553 { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", "
optional": true, "description": "Async stack trace, if any.", "hidden": true }, |
| 554 { "name": "compileError", "optional": true, "$ref": "SetScri
ptSourceError", "description": "Error data if any." } |
| 555 ], |
| 556 "description": "Edits JavaScript source live." |
| 557 }, |
| 558 { |
| 559 "name": "restartFrame", |
| 560 "parameters": [ |
| 561 { "name": "callFrameId", "$ref": "CallFrameId", "description
": "Call frame identifier to evaluate on." } |
| 562 ], |
| 563 "returns": [ |
| 564 { "name": "callFrames", "type": "array", "items": { "$ref":
"CallFrame" }, "description": "New stack trace." }, |
| 565 { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", "
optional": true, "description": "Async stack trace, if any." } |
| 566 ], |
| 567 "hidden": true, |
| 568 "description": "Restarts particular call frame from the beginnin
g." |
| 569 }, |
| 570 { |
| 571 "name": "getScriptSource", |
| 572 "parameters": [ |
| 573 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti
on": "Id of the script to get source for." } |
| 574 ], |
| 575 "returns": [ |
| 576 { "name": "scriptSource", "type": "string", "description": "
Script source." } |
| 577 ], |
| 578 "description": "Returns source for the script with given id." |
| 579 }, |
| 580 { |
| 581 "name": "getFunctionDetails", |
| 582 "hidden": true, |
| 583 "parameters": [ |
| 584 { "name": "functionId", "$ref": "Runtime.RemoteObjectId", "d
escription": "Id of the function to get details for." } |
| 585 ], |
| 586 "returns": [ |
| 587 { "name": "details", "$ref": "FunctionDetails", "description
": "Information about the function." } |
| 588 ], |
| 589 "description": "Returns detailed information on given function." |
| 590 }, |
| 591 { |
| 592 "name": "getGeneratorObjectDetails", |
| 593 "hidden": true, |
| 594 "parameters": [ |
| 595 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "des
cription": "Id of the generator object to get details for." } |
| 596 ], |
| 597 "returns": [ |
| 598 { "name": "details", "$ref": "GeneratorObjectDetails", "desc
ription": "Information about the generator object." } |
| 599 ], |
| 600 "description": "Returns detailed information on given generator
object." |
| 601 }, |
| 602 { |
| 603 "name": "getCollectionEntries", |
| 604 "hidden": true, |
| 605 "parameters": [ |
| 606 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "des
cription": "Id of the collection to get entries for." } |
| 607 ], |
| 608 "returns": [ |
| 609 { "name": "entries", "type": "array", "items": { "$ref": "Co
llectionEntry" }, "description": "Array of collection entries." } |
| 610 ], |
| 611 "description": "Returns entries of given collection." |
| 612 }, |
| 613 { |
| 614 "name": "setPauseOnExceptions", |
| 615 "parameters": [ |
| 616 { "name": "state", "type": "string", "enum": ["none", "uncau
ght", "all"], "description": "Pause on exceptions mode." } |
| 617 ], |
| 618 "description": "Defines pause on exceptions state. Can be set to
stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on
exceptions state is <code>none</code>." |
| 619 }, |
| 620 { |
| 621 "name": "evaluateOnCallFrame", |
| 622 "parameters": [ |
| 623 { "name": "callFrameId", "$ref": "CallFrameId", "description
": "Call frame identifier to evaluate on." }, |
| 624 { "name": "expression", "type": "string", "description": "Ex
pression to evaluate." }, |
| 625 { "name": "objectGroup", "type": "string", "optional": true,
"description": "String object group name to put result into (allows rapid relea
sing resulting object handles using <code>releaseObjectGroup</code>)." }, |
| 626 { "name": "includeCommandLineAPI", "type": "boolean", "optio
nal": true, "description": "Specifies whether command line API should be availab
le to the evaluated expression, defaults to false.", "hidden": true }, |
| 627 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "b
oolean", "optional": true, "description": "Specifies whether evaluation should s
top on exceptions and mute console. Overrides setPauseOnException state.", "hidd
en": true }, |
| 628 { "name": "returnByValue", "type": "boolean", "optional": tr
ue, "description": "Whether the result is expected to be a JSON object that shou
ld be sent by value." }, |
| 629 { "name": "generatePreview", "type": "boolean", "optional":
true, "hidden": true, "description": "Whether preview should be generated for th
e result." } |
| 630 ], |
| 631 "returns": [ |
| 632 { "name": "result", "$ref": "Runtime.RemoteObject", "descrip
tion": "Object wrapper for the evaluation result." }, |
| 633 { "name": "wasThrown", "type": "boolean", "optional": true,
"description": "True if the result was thrown during the evaluation." }, |
| 634 { "name": "exceptionDetails", "$ref": "Runtime.ExceptionDeta
ils", "optional": true, "hidden": true, "description": "Exception details."} |
| 635 ], |
| 636 "description": "Evaluates expression on a given call frame." |
| 637 }, |
| 638 { |
| 639 "name": "setVariableValue", |
| 640 "parameters": [ |
| 641 { "name": "scopeNumber", "type": "integer", "description": "
0-based number of scope as was listed in scope chain. Only 'local', 'closure' an
d 'catch' scope types are allowed. Other scopes could be manipulated manually."
}, |
| 642 { "name": "variableName", "type": "string", "description": "
Variable name." }, |
| 643 { "name": "newValue", "$ref": "Runtime.CallArgument", "descr
iption": "New variable value." }, |
| 644 { "name": "callFrameId", "$ref": "CallFrameId", "description
": "Id of callframe that holds variable." } |
| 645 ], |
| 646 "hidden": true, |
| 647 "description": "Changes value of variable in a callframe. Object
-based scopes are not supported and must be mutated manually." |
| 648 }, |
| 649 { |
| 650 "name": "getBacktrace", |
| 651 "returns": [ |
| 652 { "name": "callFrames", "type": "array", "items": { "$ref":
"CallFrame" }, "description": "Call stack the virtual machine stopped on." }, |
| 653 { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", "
optional": true, "description": "Async stack trace, if any." } |
| 654 ], |
| 655 "hidden": true, |
| 656 "description": "Returns call stack including variables changed s
ince VM was paused. VM must be paused." |
| 657 }, |
| 658 { |
| 659 "name": "setAsyncCallStackDepth", |
| 660 "parameters": [ |
| 661 { "name": "maxDepth", "type": "integer", "description": "Max
imum depth of async call stacks. Setting to <code>0</code> will effectively disa
ble collecting async call stacks (default)." } |
| 662 ], |
| 663 "hidden": true, |
| 664 "description": "Enables or disables async call stacks tracking." |
| 665 }, |
| 666 { |
| 667 "name": "setBlackboxPatterns", |
| 668 "parameters": [ |
| 669 { "name": "patterns", "type": "array", "items": { "type": "s
tring" }, "description": "Array of regexps that will be used to check script url
for blackbox state." } |
| 670 ], |
| 671 "hidden": true, |
| 672 "description": "Replace previous blackbox patterns with passed o
nes. 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' se
veral times, finally resorting to 'step out' if unsuccessful." |
| 673 }, |
| 674 { |
| 675 "name": "setBlackboxedRanges", |
| 676 "parameters": [ |
| 677 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti
on": "Id of the script." }, |
| 678 { "name": "positions", "type": "array", "items": { "$ref": "
ScriptPosition" } } |
| 679 ], |
| 680 "hidden": true, |
| 681 "description": "Makes backend skip steps in the script in blackb
oxed ranges. VM will try leave blacklisted scripts by performing 'step in' sever
al times, finally resorting to 'step out' if unsuccessful. Positions array conta
ins positions where blackbox state is changed. First interval isn't blackboxed.
Array should be sorted." |
| 682 } |
| 683 ], |
| 684 "events": [ |
| 685 { |
| 686 "name": "scriptParsed", |
| 687 "parameters": [ |
| 688 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti
on": "Identifier of the script parsed." }, |
| 689 { "name": "url", "type": "string", "description": "URL or na
me of the script parsed (if any)." }, |
| 690 { "name": "startLine", "type": "integer", "description": "Li
ne offset of the script within the resource with given URL (for script tags)." }
, |
| 691 { "name": "startColumn", "type": "integer", "description": "
Column offset of the script within the resource with given URL." }, |
| 692 { "name": "endLine", "type": "integer", "description": "Last
line of the script." }, |
| 693 { "name": "endColumn", "type": "integer", "description": "Le
ngth of the last line of the script." }, |
| 694 { "name": "executionContextId", "$ref": "Runtime.ExecutionCo
ntextId", "description": "Specifies script creation context.", "hidden": true }, |
| 695 { "name": "hash", "type": "string", "hidden": true, "descrip
tion": "Content hash of the script."}, |
| 696 { "name": "isContentScript", "type": "boolean", "optional":
true, "description": "Determines whether this script is a user extension script.
" }, |
| 697 { "name": "isInternalScript", "type": "boolean", "optional":
true, "description": "Determines whether this script is an internal script.", "
hidden": true }, |
| 698 { "name": "isLiveEdit", "type": "boolean", "optional": true,
"description": "True, if this script is generated as a result of the live edit
operation.", "hidden": true }, |
| 699 { "name": "sourceMapURL", "type": "string", "optional": true
, "description": "URL of source map associated with script (if any)." }, |
| 700 { "name": "hasSourceURL", "type": "boolean", "optional": tru
e, "description": "True, if this script has sourceURL.", "hidden": true }, |
| 701 { "name": "deprecatedCommentWasUsed", "type": "boolean", "op
tional": true, "hidden": true, "description": "True, if '//@ sourceURL' or '//@
sourceMappingURL' was used."} |
| 702 ], |
| 703 "description": "Fired when virtual machine parses script. This e
vent is also fired for all known and uncollected scripts upon enabling debugger.
" |
| 704 }, |
| 705 { |
| 706 "name": "scriptFailedToParse", |
| 707 "parameters": [ |
| 708 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti
on": "Identifier of the script parsed." }, |
| 709 { "name": "url", "type": "string", "description": "URL or na
me of the script parsed (if any)." }, |
| 710 { "name": "startLine", "type": "integer", "description": "Li
ne offset of the script within the resource with given URL (for script tags)." }
, |
| 711 { "name": "startColumn", "type": "integer", "description": "
Column offset of the script within the resource with given URL." }, |
| 712 { "name": "endLine", "type": "integer", "description": "Last
line of the script." }, |
| 713 { "name": "endColumn", "type": "integer", "description": "Le
ngth of the last line of the script." }, |
| 714 { "name": "executionContextId", "$ref": "Runtime.ExecutionCo
ntextId", "description": "Specifies script creation context.", "hidden": true }, |
| 715 { "name": "hash", "type": "string", "hidden": true, "descrip
tion": "Content hash of the script."}, |
| 716 { "name": "isContentScript", "type": "boolean", "optional":
true, "description": "Determines whether this script is a user extension script.
" }, |
| 717 { "name": "isInternalScript", "type": "boolean", "optional":
true, "description": "Determines whether this script is an internal script.", "
hidden": true }, |
| 718 { "name": "sourceMapURL", "type": "string", "optional": true
, "description": "URL of source map associated with script (if any)." }, |
| 719 { "name": "hasSourceURL", "type": "boolean", "optional": tru
e, "description": "True, if this script has sourceURL.", "hidden": true }, |
| 720 { "name": "deprecatedCommentWasUsed", "type": "boolean", "op
tional": true, "hidden": true, "description": "True, if '//@ sourceURL' or '//@
sourceMappingURL' was used."} |
| 721 ], |
| 722 "description": "Fired when virtual machine fails to parse the sc
ript." |
| 723 }, |
| 724 { |
| 725 "name": "breakpointResolved", |
| 726 "parameters": [ |
| 727 { "name": "breakpointId", "$ref": "BreakpointId", "descripti
on": "Breakpoint unique identifier." }, |
| 728 { "name": "location", "$ref": "Location", "description": "Ac
tual breakpoint location." } |
| 729 ], |
| 730 "description": "Fired when breakpoint is resolved to an actual s
cript and location." |
| 731 }, |
| 732 { |
| 733 "name": "paused", |
| 734 "parameters": [ |
| 735 { "name": "callFrames", "type": "array", "items": { "$ref":
"CallFrame" }, "description": "Call stack the virtual machine stopped on." }, |
| 736 { "name": "reason", "type": "string", "enum": [ "XHR", "DOM"
, "EventListener", "exception", "assert", "CSPViolation", "debugCommand", "promi
seRejection", "other" ], "description": "Pause reason." }, |
| 737 { "name": "data", "type": "object", "optional": true, "descr
iption": "Object containing break-specific auxiliary properties." }, |
| 738 { "name": "hitBreakpoints", "type": "array", "optional": tru
e, "items": { "type": "string" }, "description": "Hit breakpoints IDs", "hidden"
: true }, |
| 739 { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", "
optional": true, "description": "Async stack trace, if any.", "hidden": true } |
| 740 ], |
| 741 "description": "Fired when the virtual machine stopped on breakp
oint or exception or any other stop criteria." |
| 742 }, |
| 743 { |
| 744 "name": "resumed", |
| 745 "description": "Fired when the virtual machine resumed execution
." |
| 746 } |
| 747 ] |
| 748 }, |
| 749 { |
| 750 "domain": "Profiler", |
| 751 "dependencies": ["Runtime", "Debugger"], |
| 752 "hidden": true, |
| 753 "types": [ |
| 754 { |
| 755 "id": "CPUProfileNode", |
| 756 "type": "object", |
| 757 "description": "CPU Profile node. Holds callsite information, ex
ecution statistics and child nodes.", |
| 758 "properties": [ |
| 759 { "name": "functionName", "type": "string", "description": "
Function name." }, |
| 760 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti
on": "Script identifier." }, |
| 761 { "name": "url", "type": "string", "description": "URL." }, |
| 762 { "name": "lineNumber", "type": "integer", "description": "1
-based line number of the function start position." }, |
| 763 { "name": "columnNumber", "type": "integer", "description":
"1-based column number of the function start position." }, |
| 764 { "name": "hitCount", "type": "integer", "description": "Num
ber of samples where this node was on top of the call stack." }, |
| 765 { "name": "callUID", "type": "number", "description": "Call
UID." }, |
| 766 { "name": "children", "type": "array", "items": { "$ref": "C
PUProfileNode" }, "description": "Child nodes." }, |
| 767 { "name": "deoptReason", "type": "string", "description": "T
he reason of being not optimized. The function may be deoptimized or marked as d
on't optimize."}, |
| 768 { "name": "id", "type": "integer", "description": "Unique id
of the node." }, |
| 769 { "name": "positionTicks", "type": "array", "items": { "$ref
": "PositionTickInfo" }, "description": "An array of source position ticks." } |
| 770 ] |
| 771 }, |
| 772 { |
| 773 "id": "CPUProfile", |
| 774 "type": "object", |
| 775 "description": "Profile.", |
| 776 "properties": [ |
| 777 { "name": "head", "$ref": "CPUProfileNode" }, |
| 778 { "name": "startTime", "type": "number", "description": "Pro
filing start time in seconds." }, |
| 779 { "name": "endTime", "type": "number", "description": "Profi
ling end time in seconds." }, |
| 780 { "name": "samples", "optional": true, "type": "array", "ite
ms": { "type": "integer" }, "description": "Ids of samples top nodes." }, |
| 781 { "name": "timestamps", "optional": true, "type": "array", "
items": { "type": "number" }, "description": "Timestamps of the samples in micro
seconds." } |
| 782 ] |
| 783 }, |
| 784 { |
| 785 "id": "PositionTickInfo", |
| 786 "type": "object", |
| 787 "description": "Specifies a number of samples attributed to a ce
rtain source position.", |
| 788 "properties": [ |
| 789 { "name": "line", "type": "integer", "description": "Source
line number (1-based)." }, |
| 790 { "name": "ticks", "type": "integer", "description": "Number
of samples attributed to the source line." } |
| 791 ] |
| 792 } |
| 793 ], |
| 794 "commands": [ |
| 795 { |
| 796 "name": "enable" |
| 797 }, |
| 798 { |
| 799 "name": "disable" |
| 800 }, |
| 801 { |
| 802 "name": "setSamplingInterval", |
| 803 "parameters": [ |
| 804 { "name": "interval", "type": "integer", "description": "New
sampling interval in microseconds." } |
| 805 ], |
| 806 "description": "Changes CPU profiler sampling interval. Must be
called before CPU profiles recording started." |
| 807 }, |
| 808 { |
| 809 "name": "start" |
| 810 }, |
| 811 { |
| 812 "name": "stop", |
| 813 "returns": [ |
| 814 { "name": "profile", "$ref": "CPUProfile", "description": "R
ecorded profile." } |
| 815 ] |
| 816 } |
| 817 ], |
| 818 "events": [ |
| 819 { |
| 820 "name": "consoleProfileStarted", |
| 821 "parameters": [ |
| 822 { "name": "id", "type": "string" }, |
| 823 { "name": "location", "$ref": "Debugger.Location", "descript
ion": "Location of console.profile()." }, |
| 824 { "name": "title", "type": "string", "optional": true, "desc
ription": "Profile title passed as argument to console.profile()." } |
| 825 |
| 826 ], |
| 827 "description": "Sent when new profile recodring is started using
console.profile() call." |
| 828 }, |
| 829 { |
| 830 "name": "consoleProfileFinished", |
| 831 "parameters": [ |
| 832 { "name": "id", "type": "string" }, |
| 833 { "name": "location", "$ref": "Debugger.Location", "descript
ion": "Location of console.profileEnd()." }, |
| 834 { "name": "profile", "$ref": "CPUProfile" }, |
| 835 { "name": "title", "type": "string", "optional": true, "desc
ription": "Profile title passed as argunet to console.profile()." } |
| 836 ] |
| 837 } |
| 838 ] |
| 839 }, |
| 840 { |
| 841 "domain": "HeapProfiler", |
| 842 "dependencies": ["Runtime"], |
| 843 "hidden": true, |
| 844 "types": [ |
| 845 { |
| 846 "id": "HeapSnapshotObjectId", |
| 847 "type": "string", |
| 848 "description": "Heap snapshot object id." |
| 849 }, |
| 850 { |
| 851 "id": "SamplingHeapProfileNode", |
| 852 "type": "object", |
| 853 "description": "Sampling Heap Profile node. Holds callsite infor
mation, allocation statistics and child nodes.", |
| 854 "properties": [ |
| 855 { "name": "functionName", "type": "string", "description": "
Function name." }, |
| 856 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti
on": "Script identifier." }, |
| 857 { "name": "url", "type": "string", "description": "URL." }, |
| 858 { "name": "lineNumber", "type": "integer", "description": "1
-based line number of the function start position." }, |
| 859 { "name": "columnNumber", "type": "integer", "description":
"1-based column number of the function start position." }, |
| 860 { "name": "selfSize", "type": "number", "description": "Allo
cations size in bytes for the node excluding children." }, |
| 861 { "name": "children", "type": "array", "items": { "$ref": "S
amplingHeapProfileNode" }, "description": "Child nodes." } |
| 862 ] |
| 863 }, |
| 864 { |
| 865 "id": "SamplingHeapProfile", |
| 866 "type": "object", |
| 867 "description": "Profile.", |
| 868 "properties": [ |
| 869 { "name": "head", "$ref": "SamplingHeapProfileNode" } |
| 870 ] |
| 871 } |
| 872 ], |
| 873 "commands": [ |
| 874 { |
| 875 "name": "enable" |
| 876 }, |
| 877 { |
| 878 "name": "disable" |
| 879 }, |
| 880 { |
| 881 "name": "startTrackingHeapObjects", |
| 882 "parameters": [ |
| 883 { "name": "trackAllocations", "type": "boolean", "optional":
true } |
| 884 ] |
| 885 }, |
| 886 { |
| 887 "name": "stopTrackingHeapObjects", |
| 888 "parameters": [ |
| 889 { "name": "reportProgress", "type": "boolean", "optional": t
rue, "description": "If true 'reportHeapSnapshotProgress' events will be generat
ed while snapshot is being taken when the tracking is stopped." } |
| 890 ] |
| 891 |
| 892 }, |
| 893 { |
| 894 "name": "takeHeapSnapshot", |
| 895 "parameters": [ |
| 896 { "name": "reportProgress", "type": "boolean", "optional": t
rue, "description": "If true 'reportHeapSnapshotProgress' events will be generat
ed while snapshot is being taken." } |
| 897 ] |
| 898 }, |
| 899 { |
| 900 "name": "collectGarbage" |
| 901 }, |
| 902 { |
| 903 "name": "getObjectByHeapObjectId", |
| 904 "parameters": [ |
| 905 { "name": "objectId", "$ref": "HeapSnapshotObjectId" }, |
| 906 { "name": "objectGroup", "type": "string", "optional": true,
"description": "Symbolic group name that can be used to release multiple object
s." } |
| 907 ], |
| 908 "returns": [ |
| 909 { "name": "result", "$ref": "Runtime.RemoteObject", "descrip
tion": "Evaluation result." } |
| 910 ] |
| 911 }, |
| 912 { |
| 913 "name": "addInspectedHeapObject", |
| 914 "parameters": [ |
| 915 { "name": "heapObjectId", "$ref": "HeapSnapshotObjectId", "d
escription": "Heap snapshot object id to be accessible by means of $x command li
ne API." } |
| 916 ], |
| 917 "description": "Enables console to refer to the node with given
id via $x (see Command Line API for more details $x functions)." |
| 918 }, |
| 919 { |
| 920 "name": "getHeapObjectId", |
| 921 "parameters": [ |
| 922 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "des
cription": "Identifier of the object to get heap object id for." } |
| 923 ], |
| 924 "returns": [ |
| 925 { "name": "heapSnapshotObjectId", "$ref": "HeapSnapshotObjec
tId", "description": "Id of the heap snapshot object corresponding to the passed
remote object id." } |
| 926 ] |
| 927 }, |
| 928 { |
| 929 "name": "startSampling", |
| 930 "parameters": [ |
| 931 { "name": "samplingInterval", "type": "number", "optional":
true, "description": "Average sample interval in bytes. Poisson distribution is
used for the intervals. The default value is 32768 bytes." } |
| 932 ] |
| 933 }, |
| 934 { |
| 935 "name": "stopSampling", |
| 936 "returns": [ |
| 937 { "name": "profile", "$ref": "SamplingHeapProfile", "descrip
tion": "Recorded sampling heap profile." } |
| 938 ] |
| 939 } |
| 940 ], |
| 941 "events": [ |
| 942 { |
| 943 "name": "addHeapSnapshotChunk", |
| 944 "parameters": [ |
| 945 { "name": "chunk", "type": "string" } |
| 946 ] |
| 947 }, |
| 948 { |
| 949 "name": "resetProfiles" |
| 950 }, |
| 951 { |
| 952 "name": "reportHeapSnapshotProgress", |
| 953 "parameters": [ |
| 954 { "name": "done", "type": "integer" }, |
| 955 { "name": "total", "type": "integer" }, |
| 956 { "name": "finished", "type": "boolean", "optional": true } |
| 957 ] |
| 958 }, |
| 959 { |
| 960 "name": "lastSeenObjectId", |
| 961 "description": "If heap objects tracking has been started then b
ackend regulary 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 hea
pStatsUpdate events will be sent before a new lastSeenObjectId event.", |
| 962 "parameters": [ |
| 963 { "name": "lastSeenObjectId", "type": "integer" }, |
| 964 { "name": "timestamp", "type": "number" } |
| 965 ] |
| 966 }, |
| 967 { |
| 968 "name": "heapStatsUpdate", |
| 969 "description": "If heap objects tracking has been started then b
ackend may send update for one or more fragments", |
| 970 "parameters": [ |
| 971 { "name": "statsUpdate", "type": "array", "items": { "type":
"integer" }, "description": "An array of triplets. Each triplet describes a fra
gment. The first integer is the fragment index, the second integer is a total co
unt of objects for the fragment, the third integer is a total size of the object
s for the fragment."} |
| 972 ] |
| 973 } |
| 974 ] |
| 975 }] |
| 976 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2035653005:
DevTools: split protocol.json into files per domain. (Closed)
Base URL: https://chromium.googlesource.com/chromium/src.git@master