OLD | NEW |
(Empty) | |
| 1 { |
| 2 "domains": [ |
| 3 { |
| 4 "domain": "Runtime", |
| 5 "description": "Runtime domain exposes JavaScript runtime by means o
f remote evaluation and mirror objects. Evaluation results are returned as mirro
r object that expose object type, string representation and unique identifier th
at 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.", |
| 6 "types": [ |
| 7 { |
| 8 "id": "RemoteObjectId", |
| 9 "type": "string", |
| 10 "description": "Unique object identifier." |
| 11 }, |
| 12 { |
| 13 "id": "RemoteObject", |
| 14 "type": "object", |
| 15 "description": "Mirror object referencing original JavaScrip
t object.", |
| 16 "properties": [ |
| 17 { |
| 18 "name": "type", |
| 19 "type": "string", |
| 20 "enum": [ |
| 21 "object", |
| 22 "function", |
| 23 "undefined", |
| 24 "string", |
| 25 "number", |
| 26 "boolean" |
| 27 ], |
| 28 "description": "Object type." |
| 29 }, |
| 30 { |
| 31 "name": "subtype", |
| 32 "type": "string", |
| 33 "optional": true, |
| 34 "enum": [ |
| 35 "array", |
| 36 "null", |
| 37 "node", |
| 38 "regexp", |
| 39 "date" |
| 40 ], |
| 41 "description": "Object subtype hint. Specified for <
code>object</code> type values only." |
| 42 }, |
| 43 { |
| 44 "name": "className", |
| 45 "type": "string", |
| 46 "optional": true, |
| 47 "description": "Object class (constructor) name. Spe
cified for <code>object</code> type values only." |
| 48 }, |
| 49 { |
| 50 "name": "value", |
| 51 "type": "any", |
| 52 "optional": true, |
| 53 "description": "Remote object value (in case of prim
itive values or JSON values if it was requested)." |
| 54 }, |
| 55 { |
| 56 "name": "description", |
| 57 "type": "string", |
| 58 "optional": true, |
| 59 "description": "String representation of the object.
" |
| 60 }, |
| 61 { |
| 62 "name": "objectId", |
| 63 "$ref": "RemoteObjectId", |
| 64 "optional": true, |
| 65 "description": "Unique object identifier (for non-pr
imitive values)." |
| 66 }, |
| 67 { |
| 68 "name": "preview", |
| 69 "$ref": "ObjectPreview", |
| 70 "optional": true, |
| 71 "description": "Preview containing abbreviated prope
rty values.", |
| 72 "hidden": true |
| 73 } |
| 74 ] |
| 75 }, |
| 76 { |
| 77 "id": "ObjectPreview", |
| 78 "type": "object", |
| 79 "hidden": true, |
| 80 "description": "Object containing abbreviated remote object
value.", |
| 81 "properties": [ |
| 82 { |
| 83 "name": "lossless", |
| 84 "type": "boolean", |
| 85 "description": "Determines whether preview is lossle
ss (contains all information of the original object)." |
| 86 }, |
| 87 { |
| 88 "name": "overflow", |
| 89 "type": "boolean", |
| 90 "description": "True iff some of the properties of t
he original did not fit." |
| 91 }, |
| 92 { |
| 93 "name": "properties", |
| 94 "type": "array", |
| 95 "items": { |
| 96 "$ref": "PropertyPreview" |
| 97 }, |
| 98 "description": "List of the properties." |
| 99 } |
| 100 ] |
| 101 }, |
| 102 { |
| 103 "id": "PropertyPreview", |
| 104 "type": "object", |
| 105 "hidden": true, |
| 106 "properties": [ |
| 107 { |
| 108 "name": "name", |
| 109 "type": "string", |
| 110 "description": "Property name." |
| 111 }, |
| 112 { |
| 113 "name": "type", |
| 114 "type": "string", |
| 115 "enum": [ |
| 116 "object", |
| 117 "function", |
| 118 "undefined", |
| 119 "string", |
| 120 "number", |
| 121 "boolean" |
| 122 ], |
| 123 "description": "Object type." |
| 124 }, |
| 125 { |
| 126 "name": "value", |
| 127 "type": "string", |
| 128 "optional": true, |
| 129 "description": "User-friendly property value string.
" |
| 130 }, |
| 131 { |
| 132 "name": "valuePreview", |
| 133 "$ref": "ObjectPreview", |
| 134 "optional": true, |
| 135 "description": "Nested value preview." |
| 136 }, |
| 137 { |
| 138 "name": "subtype", |
| 139 "type": "string", |
| 140 "optional": true, |
| 141 "enum": [ |
| 142 "array", |
| 143 "null", |
| 144 "node", |
| 145 "regexp", |
| 146 "date" |
| 147 ], |
| 148 "description": "Object subtype hint. Specified for <
code>object</code> type values only." |
| 149 } |
| 150 ] |
| 151 }, |
| 152 { |
| 153 "id": "PropertyDescriptor", |
| 154 "type": "object", |
| 155 "description": "Object property descriptor.", |
| 156 "properties": [ |
| 157 { |
| 158 "name": "name", |
| 159 "type": "string", |
| 160 "description": "Property name." |
| 161 }, |
| 162 { |
| 163 "name": "value", |
| 164 "$ref": "RemoteObject", |
| 165 "optional": true, |
| 166 "description": "The value associated with the proper
ty." |
| 167 }, |
| 168 { |
| 169 "name": "writable", |
| 170 "type": "boolean", |
| 171 "optional": true, |
| 172 "description": "True if the value associated with th
e property may be changed (data descriptors only)." |
| 173 }, |
| 174 { |
| 175 "name": "get", |
| 176 "$ref": "RemoteObject", |
| 177 "optional": true, |
| 178 "description": "A function which serves as a getter
for the property, or <code>undefined</code> if there is no getter (accessor desc
riptors only)." |
| 179 }, |
| 180 { |
| 181 "name": "set", |
| 182 "$ref": "RemoteObject", |
| 183 "optional": true, |
| 184 "description": "A function which serves as a setter
for the property, or <code>undefined</code> if there is no setter (accessor desc
riptors only)." |
| 185 }, |
| 186 { |
| 187 "name": "configurable", |
| 188 "type": "boolean", |
| 189 "description": "True if the type of this property de
scriptor may be changed and if the property may be deleted from the correspondin
g object." |
| 190 }, |
| 191 { |
| 192 "name": "enumerable", |
| 193 "type": "boolean", |
| 194 "description": "True if this property shows up durin
g enumeration of the properties on the corresponding object." |
| 195 }, |
| 196 { |
| 197 "name": "wasThrown", |
| 198 "type": "boolean", |
| 199 "optional": true, |
| 200 "description": "True if the result was thrown during
the evaluation." |
| 201 }, |
| 202 { |
| 203 "name": "isOwn", |
| 204 "optional": true, |
| 205 "type": "boolean", |
| 206 "description": "True if the property is owned for th
e object.", |
| 207 "hidden": true |
| 208 } |
| 209 ] |
| 210 }, |
| 211 { |
| 212 "id": "InternalPropertyDescriptor", |
| 213 "type": "object", |
| 214 "description": "Object internal property descriptor. This pr
operty isn't normally visible in JavaScript code.", |
| 215 "properties": [ |
| 216 { |
| 217 "name": "name", |
| 218 "type": "string", |
| 219 "description": "Conventional property name." |
| 220 }, |
| 221 { |
| 222 "name": "value", |
| 223 "$ref": "RemoteObject", |
| 224 "optional": true, |
| 225 "description": "The value associated with the proper
ty." |
| 226 } |
| 227 ], |
| 228 "hidden": true |
| 229 }, |
| 230 { |
| 231 "id": "CallArgument", |
| 232 "type": "object", |
| 233 "description": "Represents function call argument. Either re
mote object id <code>objectId</code> or primitive <code>value</code> or neither
of (for undefined) them should be specified.", |
| 234 "properties": [ |
| 235 { |
| 236 "name": "value", |
| 237 "type": "any", |
| 238 "optional": true, |
| 239 "description": "Primitive value." |
| 240 }, |
| 241 { |
| 242 "name": "objectId", |
| 243 "$ref": "RemoteObjectId", |
| 244 "optional": true, |
| 245 "description": "Remote object handle." |
| 246 } |
| 247 ] |
| 248 }, |
| 249 { |
| 250 "id": "ExecutionContextId", |
| 251 "type": "integer", |
| 252 "description": "Id of an execution context." |
| 253 }, |
| 254 { |
| 255 "id": "ExecutionContextDescription", |
| 256 "type": "object", |
| 257 "description": "Description of an isolated world.", |
| 258 "properties": [ |
| 259 { |
| 260 "name": "id", |
| 261 "$ref": "ExecutionContextId", |
| 262 "description": "Unique id of the execution context.
It can be used to specify in which execution context script evaluation should be
performed." |
| 263 }, |
| 264 { |
| 265 "name": "isPageContext", |
| 266 "type": "boolean", |
| 267 "description": "True if this is a context where inps
pected web page scripts run. False if it is a content script isolated context.", |
| 268 "hidden": true |
| 269 }, |
| 270 { |
| 271 "name": "name", |
| 272 "type": "string", |
| 273 "description": "Human readable name describing given
context.", |
| 274 "hidden": true |
| 275 }, |
| 276 { |
| 277 "name": "frameId", |
| 278 "type": "string", |
| 279 "description": "Id of the owning frame." |
| 280 } |
| 281 ] |
| 282 } |
| 283 ], |
| 284 "commands": [ |
| 285 { |
| 286 "name": "evaluate", |
| 287 "parameters": [ |
| 288 { |
| 289 "name": "expression", |
| 290 "type": "string", |
| 291 "description": "Expression to evaluate." |
| 292 }, |
| 293 { |
| 294 "name": "objectGroup", |
| 295 "type": "string", |
| 296 "optional": true, |
| 297 "description": "Symbolic group name that can be used
to release multiple objects." |
| 298 }, |
| 299 { |
| 300 "name": "includeCommandLineAPI", |
| 301 "type": "boolean", |
| 302 "optional": true, |
| 303 "description": "Determines whether Command Line API
should be available during the evaluation.", |
| 304 "hidden": true |
| 305 }, |
| 306 { |
| 307 "name": "doNotPauseOnExceptionsAndMuteConsole", |
| 308 "type": "boolean", |
| 309 "optional": true, |
| 310 "description": "Specifies whether evaluation should
stop on exceptions and mute console. Overrides setPauseOnException state.", |
| 311 "hidden": true |
| 312 }, |
| 313 { |
| 314 "name": "contextId", |
| 315 "$ref": "Runtime.ExecutionContextId", |
| 316 "optional": true, |
| 317 "description": "Specifies in which isolated context
to perform evaluation. Each content script lives in an isolated context and this
parameter may be used to specify one of those contexts. If the parameter is omi
tted or 0 the evaluation will be performed in the context of the inspected page.
" |
| 318 }, |
| 319 { |
| 320 "name": "returnByValue", |
| 321 "type": "boolean", |
| 322 "optional": true, |
| 323 "description": "Whether the result is expected to be
a JSON object that should be sent by value." |
| 324 }, |
| 325 { |
| 326 "name": "generatePreview", |
| 327 "type": "boolean", |
| 328 "optional": true, |
| 329 "hidden": true, |
| 330 "description": "Whether preview should be generated
for the result." |
| 331 } |
| 332 ], |
| 333 "returns": [ |
| 334 { |
| 335 "name": "result", |
| 336 "$ref": "RemoteObject", |
| 337 "description": "Evaluation result." |
| 338 }, |
| 339 { |
| 340 "name": "wasThrown", |
| 341 "type": "boolean", |
| 342 "optional": true, |
| 343 "description": "True if the result was thrown during
the evaluation." |
| 344 } |
| 345 ], |
| 346 "description": "Evaluates expression on global object." |
| 347 }, |
| 348 { |
| 349 "name": "callFunctionOn", |
| 350 "parameters": [ |
| 351 { |
| 352 "name": "objectId", |
| 353 "$ref": "RemoteObjectId", |
| 354 "description": "Identifier of the object to call fun
ction on." |
| 355 }, |
| 356 { |
| 357 "name": "functionDeclaration", |
| 358 "type": "string", |
| 359 "description": "Declaration of the function to call.
" |
| 360 }, |
| 361 { |
| 362 "name": "arguments", |
| 363 "type": "array", |
| 364 "items": { |
| 365 "$ref": "CallArgument", |
| 366 "description": "Call argument." |
| 367 }, |
| 368 "optional": true, |
| 369 "description": "Call arguments. All call arguments m
ust belong to the same JavaScript world as the target object." |
| 370 }, |
| 371 { |
| 372 "name": "doNotPauseOnExceptionsAndMuteConsole", |
| 373 "type": "boolean", |
| 374 "optional": true, |
| 375 "description": "Specifies whether function call shou
ld stop on exceptions and mute console. Overrides setPauseOnException state.", |
| 376 "hidden": true |
| 377 }, |
| 378 { |
| 379 "name": "returnByValue", |
| 380 "type": "boolean", |
| 381 "optional": true, |
| 382 "description": "Whether the result is expected to be
a JSON object which should be sent by value." |
| 383 }, |
| 384 { |
| 385 "name": "generatePreview", |
| 386 "type": "boolean", |
| 387 "optional": true, |
| 388 "hidden": true, |
| 389 "description": "Whether preview should be generated
for the result." |
| 390 } |
| 391 ], |
| 392 "returns": [ |
| 393 { |
| 394 "name": "result", |
| 395 "$ref": "RemoteObject", |
| 396 "description": "Call result." |
| 397 }, |
| 398 { |
| 399 "name": "wasThrown", |
| 400 "type": "boolean", |
| 401 "optional": true, |
| 402 "description": "True if the result was thrown during
the evaluation." |
| 403 } |
| 404 ], |
| 405 "description": "Calls function with given declaration on the
given object. Object group of the result is inherited from the target object." |
| 406 }, |
| 407 { |
| 408 "name": "getProperties", |
| 409 "parameters": [ |
| 410 { |
| 411 "name": "objectId", |
| 412 "$ref": "RemoteObjectId", |
| 413 "description": "Identifier of the object to return p
roperties for." |
| 414 }, |
| 415 { |
| 416 "name": "ownProperties", |
| 417 "optional": true, |
| 418 "type": "boolean", |
| 419 "description": "If true, returns properties belongin
g only to the element itself, not to its prototype chain." |
| 420 }, |
| 421 { |
| 422 "name": "accessorPropertiesOnly", |
| 423 "optional": true, |
| 424 "type": "boolean", |
| 425 "description": "If true, returns accessor properties
(with getter/setter) only; internal properties are not returned either.", |
| 426 "hidden": true |
| 427 } |
| 428 ], |
| 429 "returns": [ |
| 430 { |
| 431 "name": "result", |
| 432 "type": "array", |
| 433 "items": { |
| 434 "$ref": "PropertyDescriptor" |
| 435 }, |
| 436 "description": "Object properties." |
| 437 }, |
| 438 { |
| 439 "name": "internalProperties", |
| 440 "optional": true, |
| 441 "type": "array", |
| 442 "items": { |
| 443 "$ref": "InternalPropertyDescriptor" |
| 444 }, |
| 445 "description": "Internal object properties (only of
the element itself).", |
| 446 "hidden": true |
| 447 } |
| 448 ], |
| 449 "description": "Returns properties of a given object. Object
group of the result is inherited from the target object." |
| 450 }, |
| 451 { |
| 452 "name": "releaseObject", |
| 453 "parameters": [ |
| 454 { |
| 455 "name": "objectId", |
| 456 "$ref": "RemoteObjectId", |
| 457 "description": "Identifier of the object to release.
" |
| 458 } |
| 459 ], |
| 460 "description": "Releases remote object with given id." |
| 461 }, |
| 462 { |
| 463 "name": "releaseObjectGroup", |
| 464 "parameters": [ |
| 465 { |
| 466 "name": "objectGroup", |
| 467 "type": "string", |
| 468 "description": "Symbolic object group name." |
| 469 } |
| 470 ], |
| 471 "description": "Releases all remote objects that belong to a
given group." |
| 472 }, |
| 473 { |
| 474 "name": "run", |
| 475 "hidden": true, |
| 476 "description": "Tells inspected instance(worker or page) tha
t it can run in case it was started paused." |
| 477 }, |
| 478 { |
| 479 "name": "enable", |
| 480 "description": "Enables reporting of execution contexts crea
tion by means of <code>executionContextCreated</code> event. When the reporting
gets enabled the event will be sent immediately for each existing execution cont
ext." |
| 481 }, |
| 482 { |
| 483 "name": "disable", |
| 484 "hidden": true, |
| 485 "description": "Disables reporting of execution contexts cre
ation." |
| 486 } |
| 487 ], |
| 488 "events": [ |
| 489 { |
| 490 "name": "executionContextCreated", |
| 491 "parameters": [ |
| 492 { |
| 493 "name": "context", |
| 494 "$ref": "ExecutionContextDescription", |
| 495 "description": "A newly created execution contex." |
| 496 } |
| 497 ], |
| 498 "description": "Issued when new execution context is created
." |
| 499 } |
| 500 ] |
| 501 }, |
| 502 { |
| 503 "domain": "Debugger", |
| 504 "description": "Debugger domain exposes JavaScript debugging capabil
ities. It allows setting and removing breakpoints, stepping through execution, e
xploring stack traces, etc.", |
| 505 "types": [ |
| 506 { |
| 507 "id": "SearchMatch", |
| 508 "type": "object", |
| 509 "description": "Search match for resource.", |
| 510 "properties": [ |
| 511 { |
| 512 "name": "lineNumber", |
| 513 "type": "number", |
| 514 "description": "Line number in resource content." |
| 515 }, |
| 516 { |
| 517 "name": "lineContent", |
| 518 "type": "string", |
| 519 "description": "Line with match content." |
| 520 } |
| 521 ], |
| 522 "hidden": true |
| 523 }, |
| 524 { |
| 525 "id": "BreakpointId", |
| 526 "type": "string", |
| 527 "description": "Breakpoint identifier." |
| 528 }, |
| 529 { |
| 530 "id": "ScriptId", |
| 531 "type": "string", |
| 532 "description": "Unique script identifier." |
| 533 }, |
| 534 { |
| 535 "id": "CallFrameId", |
| 536 "type": "string", |
| 537 "description": "Call frame identifier." |
| 538 }, |
| 539 { |
| 540 "id": "Location", |
| 541 "type": "object", |
| 542 "properties": [ |
| 543 { |
| 544 "name": "scriptId", |
| 545 "$ref": "ScriptId", |
| 546 "description": "Script identifier as reported in the
<code>Debugger.scriptParsed</code>." |
| 547 }, |
| 548 { |
| 549 "name": "lineNumber", |
| 550 "type": "integer", |
| 551 "description": "Line number in the script (0-based).
" |
| 552 }, |
| 553 { |
| 554 "name": "columnNumber", |
| 555 "type": "integer", |
| 556 "optional": true, |
| 557 "description": "Column number in the script (0-based
)." |
| 558 } |
| 559 ], |
| 560 "description": "Location in the source code." |
| 561 }, |
| 562 { |
| 563 "id": "FunctionDetails", |
| 564 "hidden": true, |
| 565 "type": "object", |
| 566 "properties": [ |
| 567 { |
| 568 "name": "location", |
| 569 "$ref": "Location", |
| 570 "description": "Location of the function." |
| 571 }, |
| 572 { |
| 573 "name": "name", |
| 574 "type": "string", |
| 575 "optional": true, |
| 576 "description": "Name of the function. Not present fo
r anonymous functions." |
| 577 }, |
| 578 { |
| 579 "name": "displayName", |
| 580 "type": "string", |
| 581 "optional": true, |
| 582 "description": "Display name of the function(specifi
ed in 'displayName' property on the function object)." |
| 583 }, |
| 584 { |
| 585 "name": "inferredName", |
| 586 "type": "string", |
| 587 "optional": true, |
| 588 "description": "Name of the function inferred from i
ts initial assignment." |
| 589 }, |
| 590 { |
| 591 "name": "scopeChain", |
| 592 "type": "array", |
| 593 "optional": true, |
| 594 "items": { |
| 595 "$ref": "Scope" |
| 596 }, |
| 597 "description": "Scope chain for this closure." |
| 598 } |
| 599 ], |
| 600 "description": "Information about the function." |
| 601 }, |
| 602 { |
| 603 "id": "CallFrame", |
| 604 "type": "object", |
| 605 "properties": [ |
| 606 { |
| 607 "name": "callFrameId", |
| 608 "$ref": "CallFrameId", |
| 609 "description": "Call frame identifier. This identifi
er is only valid while the virtual machine is paused." |
| 610 }, |
| 611 { |
| 612 "name": "functionName", |
| 613 "type": "string", |
| 614 "description": "Name of the JavaScript function call
ed on this call frame." |
| 615 }, |
| 616 { |
| 617 "name": "location", |
| 618 "$ref": "Location", |
| 619 "description": "Location in the source code." |
| 620 }, |
| 621 { |
| 622 "name": "scopeChain", |
| 623 "type": "array", |
| 624 "items": { |
| 625 "$ref": "Scope" |
| 626 }, |
| 627 "description": "Scope chain for this call frame." |
| 628 }, |
| 629 { |
| 630 "name": "this", |
| 631 "$ref": "Runtime.RemoteObject", |
| 632 "description": "<code>this</code> object for this ca
ll frame." |
| 633 } |
| 634 ], |
| 635 "description": "JavaScript call frame. Array of call frames
form the call stack." |
| 636 }, |
| 637 { |
| 638 "id": "Scope", |
| 639 "type": "object", |
| 640 "properties": [ |
| 641 { |
| 642 "name": "type", |
| 643 "type": "string", |
| 644 "enum": [ |
| 645 "global", |
| 646 "local", |
| 647 "with", |
| 648 "closure", |
| 649 "catch" |
| 650 ], |
| 651 "description": "Scope type." |
| 652 }, |
| 653 { |
| 654 "name": "object", |
| 655 "$ref": "Runtime.RemoteObject", |
| 656 "description": "Object representing the scope. For <
code>global</code> and <code>with</code> scopes it represents the actual object;
for the rest of the scopes, it is artificial transient object enumerating scope
variables as its properties." |
| 657 } |
| 658 ], |
| 659 "description": "Scope description." |
| 660 }, |
| 661 { |
| 662 "id": "SetScriptSourceError", |
| 663 "type": "object", |
| 664 "properties": [ |
| 665 { |
| 666 "name": "compileError", |
| 667 "optional": true, |
| 668 "type": "object", |
| 669 "properties": [ |
| 670 { |
| 671 "name": "message", |
| 672 "type": "string", |
| 673 "description": "Compiler error message" |
| 674 }, |
| 675 { |
| 676 "name": "lineNumber", |
| 677 "type": "integer", |
| 678 "description": "Compile error line number (1
-based)" |
| 679 }, |
| 680 { |
| 681 "name": "columnNumber", |
| 682 "type": "integer", |
| 683 "description": "Compile error column number
(1-based)" |
| 684 } |
| 685 ] |
| 686 } |
| 687 ], |
| 688 "description": "Error data for setScriptSource command. comp
ileError is a case type for uncompilable script source error.", |
| 689 "hidden": true |
| 690 } |
| 691 ], |
| 692 "commands": [ |
| 693 { |
| 694 "name": "enable", |
| 695 "description": "Enables debugger for the given page. Clients
should not assume that the debugging has been enabled until the result for this
command is received." |
| 696 }, |
| 697 { |
| 698 "name": "disable", |
| 699 "description": "Disables debugger for given page." |
| 700 }, |
| 701 { |
| 702 "name": "setBreakpointsActive", |
| 703 "parameters": [ |
| 704 { |
| 705 "name": "active", |
| 706 "type": "boolean", |
| 707 "description": "New value for breakpoints active sta
te." |
| 708 } |
| 709 ], |
| 710 "description": "Activates / deactivates all breakpoints on t
he page." |
| 711 }, |
| 712 { |
| 713 "name": "setSkipAllPauses", |
| 714 "hidden": true, |
| 715 "parameters": [ |
| 716 { |
| 717 "name": "skipped", |
| 718 "type": "boolean", |
| 719 "description": "New value for skip pauses state." |
| 720 }, |
| 721 { |
| 722 "name": "untilReload", |
| 723 "type": "boolean", |
| 724 "optional": true, |
| 725 "description": "Whether page reload should set skipp
ed to false." |
| 726 } |
| 727 ], |
| 728 "description": "Makes page not interrupt on any pauses (brea
kpoint, exception, dom exception etc)." |
| 729 }, |
| 730 { |
| 731 "name": "setBreakpointByUrl", |
| 732 "parameters": [ |
| 733 { |
| 734 "name": "lineNumber", |
| 735 "type": "integer", |
| 736 "description": "Line number to set breakpoint at." |
| 737 }, |
| 738 { |
| 739 "name": "url", |
| 740 "type": "string", |
| 741 "optional": true, |
| 742 "description": "URL of the resources to set breakpoi
nt on." |
| 743 }, |
| 744 { |
| 745 "name": "urlRegex", |
| 746 "type": "string", |
| 747 "optional": true, |
| 748 "description": "Regex pattern for the URLs of the re
sources to set breakpoints on. Either <code>url</code> or <code>urlRegex</code>
must be specified." |
| 749 }, |
| 750 { |
| 751 "name": "columnNumber", |
| 752 "type": "integer", |
| 753 "optional": true, |
| 754 "description": "Offset in the line to set breakpoint
at." |
| 755 }, |
| 756 { |
| 757 "name": "condition", |
| 758 "type": "string", |
| 759 "optional": true, |
| 760 "description": "Expression to use as a breakpoint co
ndition. When specified, debugger will only stop on the breakpoint if this expre
ssion evaluates to true." |
| 761 }, |
| 762 { |
| 763 "name": "isAntibreakpoint", |
| 764 "type": "boolean", |
| 765 "optional": true, |
| 766 "hidden": true, |
| 767 "description": "Creates pseudo-breakpoint that preve
nts debugger from pausing on exception at this location." |
| 768 } |
| 769 ], |
| 770 "returns": [ |
| 771 { |
| 772 "name": "breakpointId", |
| 773 "$ref": "BreakpointId", |
| 774 "description": "Id of the created breakpoint for fur
ther reference." |
| 775 }, |
| 776 { |
| 777 "name": "locations", |
| 778 "type": "array", |
| 779 "items": { |
| 780 "$ref": "Location" |
| 781 }, |
| 782 "description": "List of the locations this breakpoin
t resolved into upon addition." |
| 783 } |
| 784 ], |
| 785 "description": "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 <code>locations</
code> property. Further matching script parsing will result in subsequent <code>
breakpointResolved</code> events issued. This logical breakpoint will survive pa
ge reloads." |
| 786 }, |
| 787 { |
| 788 "name": "setBreakpoint", |
| 789 "parameters": [ |
| 790 { |
| 791 "name": "location", |
| 792 "$ref": "Location", |
| 793 "description": "Location to set breakpoint in." |
| 794 }, |
| 795 { |
| 796 "name": "condition", |
| 797 "type": "string", |
| 798 "optional": true, |
| 799 "description": "Expression to use as a breakpoint co
ndition. When specified, debugger will only stop on the breakpoint if this expre
ssion evaluates to true." |
| 800 } |
| 801 ], |
| 802 "returns": [ |
| 803 { |
| 804 "name": "breakpointId", |
| 805 "$ref": "BreakpointId", |
| 806 "description": "Id of the created breakpoint for fur
ther reference." |
| 807 }, |
| 808 { |
| 809 "name": "actualLocation", |
| 810 "$ref": "Location", |
| 811 "description": "Location this breakpoint resolved in
to." |
| 812 } |
| 813 ], |
| 814 "description": "Sets JavaScript breakpoint at a given locati
on." |
| 815 }, |
| 816 { |
| 817 "name": "removeBreakpoint", |
| 818 "parameters": [ |
| 819 { |
| 820 "name": "breakpointId", |
| 821 "$ref": "BreakpointId" |
| 822 } |
| 823 ], |
| 824 "description": "Removes JavaScript breakpoint." |
| 825 }, |
| 826 { |
| 827 "name": "continueToLocation", |
| 828 "parameters": [ |
| 829 { |
| 830 "name": "location", |
| 831 "$ref": "Location", |
| 832 "description": "Location to continue to." |
| 833 }, |
| 834 { |
| 835 "name": "interstatementLocation", |
| 836 "type": "boolean", |
| 837 "optional": true, |
| 838 "hidden": true, |
| 839 "description": "Allows breakpoints at the intemediat
e positions inside statements." |
| 840 } |
| 841 ], |
| 842 "description": "Continues execution until specific location
is reached." |
| 843 }, |
| 844 { |
| 845 "name": "stepOver", |
| 846 "description": "Steps over the statement." |
| 847 }, |
| 848 { |
| 849 "name": "stepInto", |
| 850 "description": "Steps into the function call." |
| 851 }, |
| 852 { |
| 853 "name": "stepOut", |
| 854 "description": "Steps out of the function call." |
| 855 }, |
| 856 { |
| 857 "name": "pause", |
| 858 "description": "Stops on the next JavaScript statement." |
| 859 }, |
| 860 { |
| 861 "name": "resume", |
| 862 "description": "Resumes JavaScript execution." |
| 863 }, |
| 864 { |
| 865 "name": "searchInContent", |
| 866 "parameters": [ |
| 867 { |
| 868 "name": "scriptId", |
| 869 "$ref": "ScriptId", |
| 870 "description": "Id of the script to search in." |
| 871 }, |
| 872 { |
| 873 "name": "query", |
| 874 "type": "string", |
| 875 "description": "String to search for." |
| 876 }, |
| 877 { |
| 878 "name": "caseSensitive", |
| 879 "type": "boolean", |
| 880 "optional": true, |
| 881 "description": "If true, search is case sensitive." |
| 882 }, |
| 883 { |
| 884 "name": "isRegex", |
| 885 "type": "boolean", |
| 886 "optional": true, |
| 887 "description": "If true, treats string parameter as
regex." |
| 888 } |
| 889 ], |
| 890 "returns": [ |
| 891 { |
| 892 "name": "result", |
| 893 "type": "array", |
| 894 "items": { |
| 895 "$ref": "SearchMatch" |
| 896 }, |
| 897 "description": "List of search matches." |
| 898 } |
| 899 ], |
| 900 "description": "Searches for given string in script content.
" |
| 901 }, |
| 902 { |
| 903 "name": "canSetScriptSource", |
| 904 "returns": [ |
| 905 { |
| 906 "name": "result", |
| 907 "type": "boolean", |
| 908 "description": "True if <code>setScriptSource</code>
is supported." |
| 909 } |
| 910 ], |
| 911 "description": "Always returns true." |
| 912 }, |
| 913 { |
| 914 "name": "setScriptSource", |
| 915 "parameters": [ |
| 916 { |
| 917 "name": "scriptId", |
| 918 "$ref": "ScriptId", |
| 919 "description": "Id of the script to edit." |
| 920 }, |
| 921 { |
| 922 "name": "scriptSource", |
| 923 "type": "string", |
| 924 "description": "New content of the script." |
| 925 }, |
| 926 { |
| 927 "name": "preview", |
| 928 "type": "boolean", |
| 929 "optional": true, |
| 930 "description": " If true the change will not actuall
y be applied. Preview mode may be used to get result description without actuall
y modifying the code.", |
| 931 "hidden": true |
| 932 } |
| 933 ], |
| 934 "returns": [ |
| 935 { |
| 936 "name": "callFrames", |
| 937 "type": "array", |
| 938 "optional": true, |
| 939 "items": { |
| 940 "$ref": "CallFrame" |
| 941 }, |
| 942 "description": "New stack trace in case editing has
happened while VM was stopped." |
| 943 }, |
| 944 { |
| 945 "name": "result", |
| 946 "type": "object", |
| 947 "optional": true, |
| 948 "description": "VM-specific description of the chang
es applied.", |
| 949 "hidden": true |
| 950 } |
| 951 ], |
| 952 "error": { |
| 953 "$ref": "SetScriptSourceError" |
| 954 }, |
| 955 "description": "Edits JavaScript source live." |
| 956 }, |
| 957 { |
| 958 "name": "restartFrame", |
| 959 "parameters": [ |
| 960 { |
| 961 "name": "callFrameId", |
| 962 "$ref": "CallFrameId", |
| 963 "description": "Call frame identifier to evaluate on
." |
| 964 } |
| 965 ], |
| 966 "returns": [ |
| 967 { |
| 968 "name": "callFrames", |
| 969 "type": "array", |
| 970 "items": { |
| 971 "$ref": "CallFrame" |
| 972 }, |
| 973 "description": "New stack trace." |
| 974 }, |
| 975 { |
| 976 "name": "result", |
| 977 "type": "object", |
| 978 "description": "VM-specific description.", |
| 979 "hidden": true |
| 980 } |
| 981 ], |
| 982 "hidden": true, |
| 983 "description": "Restarts particular call frame from the begi
nning." |
| 984 }, |
| 985 { |
| 986 "name": "getScriptSource", |
| 987 "parameters": [ |
| 988 { |
| 989 "name": "scriptId", |
| 990 "$ref": "ScriptId", |
| 991 "description": "Id of the script to get source for." |
| 992 } |
| 993 ], |
| 994 "returns": [ |
| 995 { |
| 996 "name": "scriptSource", |
| 997 "type": "string", |
| 998 "description": "Script source." |
| 999 } |
| 1000 ], |
| 1001 "description": "Returns source for the script with given id.
" |
| 1002 }, |
| 1003 { |
| 1004 "name": "getFunctionDetails", |
| 1005 "hidden": true, |
| 1006 "parameters": [ |
| 1007 { |
| 1008 "name": "functionId", |
| 1009 "$ref": "Runtime.RemoteObjectId", |
| 1010 "description": "Id of the function to get location f
or." |
| 1011 } |
| 1012 ], |
| 1013 "returns": [ |
| 1014 { |
| 1015 "name": "details", |
| 1016 "$ref": "FunctionDetails", |
| 1017 "description": "Information about the function." |
| 1018 } |
| 1019 ], |
| 1020 "description": "Returns detailed informtation on given funct
ion." |
| 1021 }, |
| 1022 { |
| 1023 "name": "setPauseOnExceptions", |
| 1024 "parameters": [ |
| 1025 { |
| 1026 "name": "state", |
| 1027 "type": "string", |
| 1028 "enum": [ |
| 1029 "none", |
| 1030 "uncaught", |
| 1031 "all" |
| 1032 ], |
| 1033 "description": "Pause on exceptions mode." |
| 1034 } |
| 1035 ], |
| 1036 "description": "Defines pause on exceptions state. Can be se
t to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause
on exceptions state is <code>none</code>." |
| 1037 }, |
| 1038 { |
| 1039 "name": "evaluateOnCallFrame", |
| 1040 "parameters": [ |
| 1041 { |
| 1042 "name": "callFrameId", |
| 1043 "$ref": "CallFrameId", |
| 1044 "description": "Call frame identifier to evaluate on
." |
| 1045 }, |
| 1046 { |
| 1047 "name": "expression", |
| 1048 "type": "string", |
| 1049 "description": "Expression to evaluate." |
| 1050 }, |
| 1051 { |
| 1052 "name": "objectGroup", |
| 1053 "type": "string", |
| 1054 "optional": true, |
| 1055 "description": "String object group name to put resu
lt into (allows rapid releasing resulting object handles using <code>releaseObje
ctGroup</code>)." |
| 1056 }, |
| 1057 { |
| 1058 "name": "includeCommandLineAPI", |
| 1059 "type": "boolean", |
| 1060 "optional": true, |
| 1061 "description": "Specifies whether command line API s
hould be available to the evaluated expression, defaults to false.", |
| 1062 "hidden": true |
| 1063 }, |
| 1064 { |
| 1065 "name": "doNotPauseOnExceptionsAndMuteConsole", |
| 1066 "type": "boolean", |
| 1067 "optional": true, |
| 1068 "description": "Specifies whether evaluation should
stop on exceptions and mute console. Overrides setPauseOnException state.", |
| 1069 "hidden": true |
| 1070 }, |
| 1071 { |
| 1072 "name": "returnByValue", |
| 1073 "type": "boolean", |
| 1074 "optional": true, |
| 1075 "description": "Whether the result is expected to be
a JSON object that should be sent by value." |
| 1076 }, |
| 1077 { |
| 1078 "name": "generatePreview", |
| 1079 "type": "boolean", |
| 1080 "optional": true, |
| 1081 "hidden": true, |
| 1082 "description": "Whether preview should be generated
for the result." |
| 1083 } |
| 1084 ], |
| 1085 "returns": [ |
| 1086 { |
| 1087 "name": "result", |
| 1088 "$ref": "Runtime.RemoteObject", |
| 1089 "description": "Object wrapper for the evaluation re
sult." |
| 1090 }, |
| 1091 { |
| 1092 "name": "wasThrown", |
| 1093 "type": "boolean", |
| 1094 "optional": true, |
| 1095 "description": "True if the result was thrown during
the evaluation." |
| 1096 } |
| 1097 ], |
| 1098 "description": "Evaluates expression on a given call frame." |
| 1099 }, |
| 1100 { |
| 1101 "name": "compileScript", |
| 1102 "hidden": true, |
| 1103 "parameters": [ |
| 1104 { |
| 1105 "name": "expression", |
| 1106 "type": "string", |
| 1107 "description": "Expression to compile." |
| 1108 }, |
| 1109 { |
| 1110 "name": "sourceURL", |
| 1111 "type": "string", |
| 1112 "description": "Source url to be set for the script.
" |
| 1113 } |
| 1114 ], |
| 1115 "returns": [ |
| 1116 { |
| 1117 "name": "scriptId", |
| 1118 "$ref": "ScriptId", |
| 1119 "optional": true, |
| 1120 "description": "Id of the script." |
| 1121 }, |
| 1122 { |
| 1123 "name": "syntaxErrorMessage", |
| 1124 "type": "string", |
| 1125 "optional": true, |
| 1126 "description": "Syntax error message if compilation
failed." |
| 1127 } |
| 1128 ], |
| 1129 "description": "Compiles expression." |
| 1130 }, |
| 1131 { |
| 1132 "name": "runScript", |
| 1133 "hidden": true, |
| 1134 "parameters": [ |
| 1135 { |
| 1136 "name": "scriptId", |
| 1137 "$ref": "ScriptId", |
| 1138 "description": "Id of the script to run." |
| 1139 }, |
| 1140 { |
| 1141 "name": "contextId", |
| 1142 "$ref": "Runtime.ExecutionContextId", |
| 1143 "optional": true, |
| 1144 "description": "Specifies in which isolated context
to perform script run. Each content script lives in an isolated context and this
parameter may be used to specify one of those contexts. If the parameter is omi
tted or 0 the evaluation will be performed in the context of the inspected page.
" |
| 1145 }, |
| 1146 { |
| 1147 "name": "objectGroup", |
| 1148 "type": "string", |
| 1149 "optional": true, |
| 1150 "description": "Symbolic group name that can be used
to release multiple objects." |
| 1151 }, |
| 1152 { |
| 1153 "name": "doNotPauseOnExceptionsAndMuteConsole", |
| 1154 "type": "boolean", |
| 1155 "optional": true, |
| 1156 "description": "Specifies whether script run should
stop on exceptions and mute console. Overrides setPauseOnException state." |
| 1157 } |
| 1158 ], |
| 1159 "returns": [ |
| 1160 { |
| 1161 "name": "result", |
| 1162 "$ref": "Runtime.RemoteObject", |
| 1163 "description": "Run result." |
| 1164 }, |
| 1165 { |
| 1166 "name": "wasThrown", |
| 1167 "type": "boolean", |
| 1168 "optional": true, |
| 1169 "description": "True if the result was thrown during
the script run." |
| 1170 } |
| 1171 ], |
| 1172 "description": "Runs script with given id in a given context
." |
| 1173 }, |
| 1174 { |
| 1175 "name": "setOverlayMessage", |
| 1176 "parameters": [ |
| 1177 { |
| 1178 "name": "message", |
| 1179 "type": "string", |
| 1180 "optional": true, |
| 1181 "description": "Overlay message to display when paus
ed in debugger." |
| 1182 } |
| 1183 ], |
| 1184 "hidden": true, |
| 1185 "description": "Sets overlay message." |
| 1186 }, |
| 1187 { |
| 1188 "name": "setVariableValue", |
| 1189 "parameters": [ |
| 1190 { |
| 1191 "name": "scopeNumber", |
| 1192 "type": "integer", |
| 1193 "description": "0-based number of scope as was liste
d in scope chain. Only 'local', 'closure' and 'catch' scope types are allowed. O
ther scopes could be manipulated manually." |
| 1194 }, |
| 1195 { |
| 1196 "name": "variableName", |
| 1197 "type": "string", |
| 1198 "description": "Variable name." |
| 1199 }, |
| 1200 { |
| 1201 "name": "newValue", |
| 1202 "$ref": "Runtime.CallArgument", |
| 1203 "description": "New variable value." |
| 1204 }, |
| 1205 { |
| 1206 "name": "callFrameId", |
| 1207 "$ref": "CallFrameId", |
| 1208 "optional": true, |
| 1209 "description": "Id of callframe that holds variable.
" |
| 1210 }, |
| 1211 { |
| 1212 "name": "functionObjectId", |
| 1213 "$ref": "Runtime.RemoteObjectId", |
| 1214 "optional": true, |
| 1215 "description": "Object id of closure (function) that
holds variable." |
| 1216 } |
| 1217 ], |
| 1218 "hidden": true, |
| 1219 "description": "Changes value of variable in a callframe or
a closure. Either callframe or function must be specified. Object-based scopes a
re not supported and must be mutated manually." |
| 1220 }, |
| 1221 { |
| 1222 "name": "getStepInPositions", |
| 1223 "parameters": [ |
| 1224 { |
| 1225 "name": "callFrameId", |
| 1226 "$ref": "CallFrameId", |
| 1227 "description": "Id of a call frame where the current
statement should be analized" |
| 1228 } |
| 1229 ], |
| 1230 "returns": [ |
| 1231 { |
| 1232 "name": "stepInPositions", |
| 1233 "type": "array", |
| 1234 "items": { |
| 1235 "$ref": "Location" |
| 1236 }, |
| 1237 "optional": true, |
| 1238 "description": "experimental" |
| 1239 } |
| 1240 ], |
| 1241 "hidden": true, |
| 1242 "description": "Lists all positions where step-in is possibl
e for a current statement in a specified call frame" |
| 1243 }, |
| 1244 { |
| 1245 "name": "getBacktrace", |
| 1246 "returns": [ |
| 1247 { |
| 1248 "name": "callFrames", |
| 1249 "type": "array", |
| 1250 "items": { |
| 1251 "$ref": "CallFrame" |
| 1252 }, |
| 1253 "description": "Call stack the virtual machine stopp
ed on." |
| 1254 } |
| 1255 ], |
| 1256 "hidden": true, |
| 1257 "description": "Returns call stack including variables chang
ed since VM was paused. VM must be paused." |
| 1258 }, |
| 1259 { |
| 1260 "name": "skipStackFrames", |
| 1261 "parameters": [ |
| 1262 { |
| 1263 "name": "script", |
| 1264 "optional": true, |
| 1265 "type": "string", |
| 1266 "description": "Regular expression defining the scri
pts to ignore while stepping." |
| 1267 } |
| 1268 ], |
| 1269 "hidden": true, |
| 1270 "description": "Makes backend skip steps in the sources with
names matching given pattern. VM will try leave blacklisted scripts by performi
ng 'step in' several times, finally resorting to 'step out' if unsuccessful." |
| 1271 } |
| 1272 ], |
| 1273 "events": [ |
| 1274 { |
| 1275 "name": "globalObjectCleared", |
| 1276 "description": "Called when global has been cleared and debu
gger client should reset its state. Happens upon navigation or reload." |
| 1277 }, |
| 1278 { |
| 1279 "name": "scriptParsed", |
| 1280 "parameters": [ |
| 1281 { |
| 1282 "name": "scriptId", |
| 1283 "$ref": "ScriptId", |
| 1284 "description": "Identifier of the script parsed." |
| 1285 }, |
| 1286 { |
| 1287 "name": "url", |
| 1288 "type": "string", |
| 1289 "description": "URL or name of the script parsed (if
any)." |
| 1290 }, |
| 1291 { |
| 1292 "name": "startLine", |
| 1293 "type": "integer", |
| 1294 "description": "Line offset of the script within the
resource with given URL (for script tags)." |
| 1295 }, |
| 1296 { |
| 1297 "name": "startColumn", |
| 1298 "type": "integer", |
| 1299 "description": "Column offset of the script within t
he resource with given URL." |
| 1300 }, |
| 1301 { |
| 1302 "name": "endLine", |
| 1303 "type": "integer", |
| 1304 "description": "Last line of the script." |
| 1305 }, |
| 1306 { |
| 1307 "name": "endColumn", |
| 1308 "type": "integer", |
| 1309 "description": "Length of the last line of the scrip
t." |
| 1310 }, |
| 1311 { |
| 1312 "name": "isContentScript", |
| 1313 "type": "boolean", |
| 1314 "optional": true, |
| 1315 "description": "Determines whether this script is a
user extension script." |
| 1316 }, |
| 1317 { |
| 1318 "name": "sourceMapURL", |
| 1319 "type": "string", |
| 1320 "optional": true, |
| 1321 "description": "URL of source map associated with sc
ript (if any)." |
| 1322 }, |
| 1323 { |
| 1324 "name": "hasSourceURL", |
| 1325 "type": "boolean", |
| 1326 "optional": true, |
| 1327 "description": "True, if this script has sourceURL."
, |
| 1328 "hidden": true |
| 1329 } |
| 1330 ], |
| 1331 "description": "Fired when virtual machine parses script. Th
is event is also fired for all known and uncollected scripts upon enabling debug
ger." |
| 1332 }, |
| 1333 { |
| 1334 "name": "scriptFailedToParse", |
| 1335 "parameters": [ |
| 1336 { |
| 1337 "name": "scriptId", |
| 1338 "$ref": "ScriptId", |
| 1339 "description": "Identifier of the script parsed." |
| 1340 }, |
| 1341 { |
| 1342 "name": "url", |
| 1343 "type": "string", |
| 1344 "description": "URL or name of the script parsed (if
any)." |
| 1345 }, |
| 1346 { |
| 1347 "name": "startLine", |
| 1348 "type": "integer", |
| 1349 "description": "Line offset of the script within the
resource with given URL (for script tags)." |
| 1350 }, |
| 1351 { |
| 1352 "name": "startColumn", |
| 1353 "type": "integer", |
| 1354 "description": "Column offset of the script within t
he resource with given URL." |
| 1355 }, |
| 1356 { |
| 1357 "name": "endLine", |
| 1358 "type": "integer", |
| 1359 "description": "Last line of the script." |
| 1360 }, |
| 1361 { |
| 1362 "name": "endColumn", |
| 1363 "type": "integer", |
| 1364 "description": "Length of the last line of the scrip
t." |
| 1365 }, |
| 1366 { |
| 1367 "name": "isContentScript", |
| 1368 "type": "boolean", |
| 1369 "optional": true, |
| 1370 "description": "Determines whether this script is a
user extension script." |
| 1371 }, |
| 1372 { |
| 1373 "name": "sourceMapURL", |
| 1374 "type": "string", |
| 1375 "optional": true, |
| 1376 "description": "URL of source map associated with sc
ript (if any)." |
| 1377 }, |
| 1378 { |
| 1379 "name": "hasSourceURL", |
| 1380 "type": "boolean", |
| 1381 "optional": true, |
| 1382 "description": "True, if this script has sourceURL."
, |
| 1383 "hidden": true |
| 1384 } |
| 1385 ], |
| 1386 "description": "Fired when virtual machine fails to parse th
e script." |
| 1387 }, |
| 1388 { |
| 1389 "name": "breakpointResolved", |
| 1390 "parameters": [ |
| 1391 { |
| 1392 "name": "breakpointId", |
| 1393 "$ref": "BreakpointId", |
| 1394 "description": "Breakpoint unique identifier." |
| 1395 }, |
| 1396 { |
| 1397 "name": "location", |
| 1398 "$ref": "Location", |
| 1399 "description": "Actual breakpoint location." |
| 1400 } |
| 1401 ], |
| 1402 "description": "Fired when breakpoint is resolved to an actu
al script and location." |
| 1403 }, |
| 1404 { |
| 1405 "name": "paused", |
| 1406 "parameters": [ |
| 1407 { |
| 1408 "name": "callFrames", |
| 1409 "type": "array", |
| 1410 "items": { |
| 1411 "$ref": "CallFrame" |
| 1412 }, |
| 1413 "description": "Call stack the virtual machine stopp
ed on." |
| 1414 }, |
| 1415 { |
| 1416 "name": "reason", |
| 1417 "type": "string", |
| 1418 "enum": [ |
| 1419 "XHR", |
| 1420 "DOM", |
| 1421 "EventListener", |
| 1422 "exception", |
| 1423 "assert", |
| 1424 "CSPViolation", |
| 1425 "debugCommand", |
| 1426 "other" |
| 1427 ], |
| 1428 "description": "Pause reason." |
| 1429 }, |
| 1430 { |
| 1431 "name": "data", |
| 1432 "type": "object", |
| 1433 "optional": true, |
| 1434 "description": "Object containing break-specific aux
iliary properties." |
| 1435 }, |
| 1436 { |
| 1437 "name": "hitBreakpoints", |
| 1438 "type": "array", |
| 1439 "optional": true, |
| 1440 "items": { |
| 1441 "type": "string" |
| 1442 }, |
| 1443 "description": "Hit breakpoints IDs", |
| 1444 "hidden": true |
| 1445 } |
| 1446 ], |
| 1447 "description": "Fired when the virtual machine stopped on br
eakpoint or exception or any other stop criteria." |
| 1448 }, |
| 1449 { |
| 1450 "name": "resumed", |
| 1451 "description": "Fired when the virtual machine resumed execu
tion." |
| 1452 } |
| 1453 ] |
| 1454 }, |
| 1455 { |
| 1456 "domain": "Profiler", |
| 1457 "hidden": true, |
| 1458 "types": [ |
| 1459 { |
| 1460 "id": "ProfileHeader", |
| 1461 "type": "object", |
| 1462 "description": "Profile header.", |
| 1463 "properties": [ |
| 1464 { |
| 1465 "name": "title", |
| 1466 "type": "string", |
| 1467 "description": "Profile title." |
| 1468 }, |
| 1469 { |
| 1470 "name": "uid", |
| 1471 "type": "integer", |
| 1472 "description": "Unique identifier of the profile." |
| 1473 } |
| 1474 ] |
| 1475 }, |
| 1476 { |
| 1477 "id": "CPUProfileNode", |
| 1478 "type": "object", |
| 1479 "description": "CPU Profile node. Holds callsite information
, execution statistics and child nodes.", |
| 1480 "properties": [ |
| 1481 { |
| 1482 "name": "functionName", |
| 1483 "type": "string", |
| 1484 "description": "Function name." |
| 1485 }, |
| 1486 { |
| 1487 "name": "scriptId", |
| 1488 "$ref": "Debugger.ScriptId", |
| 1489 "description": "Script identifier." |
| 1490 }, |
| 1491 { |
| 1492 "name": "url", |
| 1493 "type": "string", |
| 1494 "description": "URL." |
| 1495 }, |
| 1496 { |
| 1497 "name": "lineNumber", |
| 1498 "type": "integer", |
| 1499 "description": "Line number." |
| 1500 }, |
| 1501 { |
| 1502 "name": "hitCount", |
| 1503 "type": "integer", |
| 1504 "description": "Number of samples where this node wa
s on top of the call stack." |
| 1505 }, |
| 1506 { |
| 1507 "name": "callUID", |
| 1508 "type": "number", |
| 1509 "description": "Call UID." |
| 1510 }, |
| 1511 { |
| 1512 "name": "children", |
| 1513 "type": "array", |
| 1514 "items": { |
| 1515 "$ref": "CPUProfileNode" |
| 1516 }, |
| 1517 "description": "Child nodes." |
| 1518 }, |
| 1519 { |
| 1520 "name": "deoptReason", |
| 1521 "type": "string", |
| 1522 "description": "The reason of being not optimized. T
he function may be deoptimized or marked as don't optimize." |
| 1523 }, |
| 1524 { |
| 1525 "name": "id", |
| 1526 "optional": true, |
| 1527 "type": "integer", |
| 1528 "description": "Unique id of the node." |
| 1529 } |
| 1530 ] |
| 1531 }, |
| 1532 { |
| 1533 "id": "CPUProfile", |
| 1534 "type": "object", |
| 1535 "description": "Profile.", |
| 1536 "properties": [ |
| 1537 { |
| 1538 "name": "head", |
| 1539 "$ref": "CPUProfileNode" |
| 1540 }, |
| 1541 { |
| 1542 "name": "startTime", |
| 1543 "type": "number", |
| 1544 "description": "Profiling start time in seconds." |
| 1545 }, |
| 1546 { |
| 1547 "name": "endTime", |
| 1548 "type": "number", |
| 1549 "description": "Profiling end time in seconds." |
| 1550 }, |
| 1551 { |
| 1552 "name": "samples", |
| 1553 "optional": true, |
| 1554 "type": "array", |
| 1555 "items": { |
| 1556 "type": "integer" |
| 1557 }, |
| 1558 "description": "Ids of samples top nodes." |
| 1559 } |
| 1560 ] |
| 1561 }, |
| 1562 { |
| 1563 "id": "HeapSnapshotObjectId", |
| 1564 "type": "string", |
| 1565 "description": "Heap snashot object id." |
| 1566 } |
| 1567 ], |
| 1568 "commands": [ |
| 1569 { |
| 1570 "name": "enable" |
| 1571 }, |
| 1572 { |
| 1573 "name": "disable" |
| 1574 }, |
| 1575 { |
| 1576 "name": "start" |
| 1577 }, |
| 1578 { |
| 1579 "name": "stop", |
| 1580 "returns": [ |
| 1581 { |
| 1582 "name": "header", |
| 1583 "$ref": "ProfileHeader", |
| 1584 "description": "The header of the recorded profile." |
| 1585 } |
| 1586 ] |
| 1587 }, |
| 1588 { |
| 1589 "name": "getProfileHeaders", |
| 1590 "returns": [ |
| 1591 { |
| 1592 "name": "headers", |
| 1593 "type": "array", |
| 1594 "items": { |
| 1595 "$ref": "ProfileHeader" |
| 1596 } |
| 1597 } |
| 1598 ] |
| 1599 }, |
| 1600 { |
| 1601 "name": "getCPUProfile", |
| 1602 "parameters": [ |
| 1603 { |
| 1604 "name": "uid", |
| 1605 "type": "integer" |
| 1606 } |
| 1607 ], |
| 1608 "returns": [ |
| 1609 { |
| 1610 "name": "profile", |
| 1611 "$ref": "CPUProfile" |
| 1612 } |
| 1613 ] |
| 1614 }, |
| 1615 { |
| 1616 "name": "removeProfile", |
| 1617 "parameters": [ |
| 1618 { |
| 1619 "name": "type", |
| 1620 "type": "string" |
| 1621 }, |
| 1622 { |
| 1623 "name": "uid", |
| 1624 "type": "integer" |
| 1625 } |
| 1626 ] |
| 1627 }, |
| 1628 { |
| 1629 "name": "clearProfiles" |
| 1630 } |
| 1631 ], |
| 1632 "events": [ |
| 1633 { |
| 1634 "name": "addProfileHeader", |
| 1635 "parameters": [ |
| 1636 { |
| 1637 "name": "header", |
| 1638 "$ref": "ProfileHeader" |
| 1639 } |
| 1640 ] |
| 1641 }, |
| 1642 { |
| 1643 "name": "setRecordingProfile", |
| 1644 "parameters": [ |
| 1645 { |
| 1646 "name": "isProfiling", |
| 1647 "type": "boolean" |
| 1648 } |
| 1649 ] |
| 1650 }, |
| 1651 { |
| 1652 "name": "resetProfiles" |
| 1653 } |
| 1654 ] |
| 1655 }, |
| 1656 { |
| 1657 "domain": "HeapProfiler", |
| 1658 "hidden": true, |
| 1659 "types": [ |
| 1660 { |
| 1661 "id": "ProfileHeader", |
| 1662 "type": "object", |
| 1663 "description": "Profile header.", |
| 1664 "properties": [ |
| 1665 { |
| 1666 "name": "title", |
| 1667 "type": "string", |
| 1668 "description": "Profile title." |
| 1669 }, |
| 1670 { |
| 1671 "name": "uid", |
| 1672 "type": "integer", |
| 1673 "description": "Unique identifier of the profile." |
| 1674 }, |
| 1675 { |
| 1676 "name": "maxJSObjectId", |
| 1677 "type": "integer", |
| 1678 "optional": true, |
| 1679 "description": "Last seen JS object Id." |
| 1680 } |
| 1681 ] |
| 1682 }, |
| 1683 { |
| 1684 "id": "HeapSnapshotObjectId", |
| 1685 "type": "string", |
| 1686 "description": "Heap snashot object id." |
| 1687 } |
| 1688 ], |
| 1689 "commands": [ |
| 1690 { |
| 1691 "name": "getProfileHeaders", |
| 1692 "returns": [ |
| 1693 { |
| 1694 "name": "headers", |
| 1695 "type": "array", |
| 1696 "items": { |
| 1697 "$ref": "ProfileHeader" |
| 1698 } |
| 1699 } |
| 1700 ] |
| 1701 }, |
| 1702 { |
| 1703 "name": "startTrackingHeapObjects" |
| 1704 }, |
| 1705 { |
| 1706 "name": "stopTrackingHeapObjects" |
| 1707 }, |
| 1708 { |
| 1709 "name": "getHeapSnapshot", |
| 1710 "parameters": [ |
| 1711 { |
| 1712 "name": "uid", |
| 1713 "type": "integer" |
| 1714 } |
| 1715 ] |
| 1716 }, |
| 1717 { |
| 1718 "name": "removeProfile", |
| 1719 "parameters": [ |
| 1720 { |
| 1721 "name": "uid", |
| 1722 "type": "integer" |
| 1723 } |
| 1724 ] |
| 1725 }, |
| 1726 { |
| 1727 "name": "clearProfiles" |
| 1728 }, |
| 1729 { |
| 1730 "name": "takeHeapSnapshot", |
| 1731 "parameters": [ |
| 1732 { |
| 1733 "name": "reportProgress", |
| 1734 "type": "boolean", |
| 1735 "optional": true, |
| 1736 "description": "If true 'reportHeapSnapshotProgress'
events will be generated while snapshot is being taken." |
| 1737 } |
| 1738 ] |
| 1739 }, |
| 1740 { |
| 1741 "name": "collectGarbage" |
| 1742 }, |
| 1743 { |
| 1744 "name": "getObjectByHeapObjectId", |
| 1745 "parameters": [ |
| 1746 { |
| 1747 "name": "objectId", |
| 1748 "$ref": "HeapSnapshotObjectId" |
| 1749 }, |
| 1750 { |
| 1751 "name": "objectGroup", |
| 1752 "type": "string", |
| 1753 "optional": true, |
| 1754 "description": "Symbolic group name that can be used
to release multiple objects." |
| 1755 } |
| 1756 ], |
| 1757 "returns": [ |
| 1758 { |
| 1759 "name": "result", |
| 1760 "$ref": "Runtime.RemoteObject", |
| 1761 "description": "Evaluation result." |
| 1762 } |
| 1763 ] |
| 1764 }, |
| 1765 { |
| 1766 "name": "getHeapObjectId", |
| 1767 "parameters": [ |
| 1768 { |
| 1769 "name": "objectId", |
| 1770 "$ref": "Runtime.RemoteObjectId", |
| 1771 "description": "Identifier of the object to get heap
object id for." |
| 1772 } |
| 1773 ], |
| 1774 "returns": [ |
| 1775 { |
| 1776 "name": "heapSnapshotObjectId", |
| 1777 "$ref": "HeapSnapshotObjectId", |
| 1778 "description": "Id of the heap snapshot object corre
sponding to the passed remote object id." |
| 1779 } |
| 1780 ] |
| 1781 } |
| 1782 ], |
| 1783 "events": [ |
| 1784 { |
| 1785 "name": "addProfileHeader", |
| 1786 "parameters": [ |
| 1787 { |
| 1788 "name": "header", |
| 1789 "$ref": "ProfileHeader" |
| 1790 } |
| 1791 ] |
| 1792 }, |
| 1793 { |
| 1794 "name": "addHeapSnapshotChunk", |
| 1795 "parameters": [ |
| 1796 { |
| 1797 "name": "uid", |
| 1798 "type": "integer" |
| 1799 }, |
| 1800 { |
| 1801 "name": "chunk", |
| 1802 "type": "string" |
| 1803 } |
| 1804 ] |
| 1805 }, |
| 1806 { |
| 1807 "name": "finishHeapSnapshot", |
| 1808 "parameters": [ |
| 1809 { |
| 1810 "name": "uid", |
| 1811 "type": "integer" |
| 1812 } |
| 1813 ] |
| 1814 }, |
| 1815 { |
| 1816 "name": "resetProfiles" |
| 1817 }, |
| 1818 { |
| 1819 "name": "reportHeapSnapshotProgress", |
| 1820 "parameters": [ |
| 1821 { |
| 1822 "name": "done", |
| 1823 "type": "integer" |
| 1824 }, |
| 1825 { |
| 1826 "name": "total", |
| 1827 "type": "integer" |
| 1828 } |
| 1829 ] |
| 1830 }, |
| 1831 { |
| 1832 "name": "lastSeenObjectId", |
| 1833 "description": "If heap objects tracking has been started th
en backend regulary sends a current value for last seen object id and correspond
ing 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.", |
| 1834 "parameters": [ |
| 1835 { |
| 1836 "name": "lastSeenObjectId", |
| 1837 "type": "integer" |
| 1838 }, |
| 1839 { |
| 1840 "name": "timestamp", |
| 1841 "type": "number" |
| 1842 } |
| 1843 ] |
| 1844 }, |
| 1845 { |
| 1846 "name": "heapStatsUpdate", |
| 1847 "description": "If heap objects tracking has been started th
en backend may send update for one or more fragments", |
| 1848 "parameters": [ |
| 1849 { |
| 1850 "name": "statsUpdate", |
| 1851 "type": "array", |
| 1852 "items": { |
| 1853 "type": "integer" |
| 1854 }, |
| 1855 "description": "An array of triplets. Each triplet d
escribes 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." |
| 1856 } |
| 1857 ] |
| 1858 } |
| 1859 ] |
| 1860 } |
| 1861 ], |
| 1862 "version": { |
| 1863 "major": "1", |
| 1864 "minor": "1" |
| 1865 } |
| 1866 } |
OLD | NEW |