Software zum Installieren eines Smart-Mirror Frameworks , zum Nutzen von hochschulrelevanten Informationen, auf einem Raspberry-Pi.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

js_protocol.pdl 58KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659
  1. # Copyright 2017 The Chromium Authors. All rights reserved.
  2. # Use of this source code is governed by a BSD-style license that can be
  3. # found in the LICENSE file.
  4. version
  5. major 1
  6. minor 3
  7. # This domain is deprecated - use Runtime or Log instead.
  8. deprecated domain Console
  9. depends on Runtime
  10. # Console message.
  11. type ConsoleMessage extends object
  12. properties
  13. # Message source.
  14. enum source
  15. xml
  16. javascript
  17. network
  18. console-api
  19. storage
  20. appcache
  21. rendering
  22. security
  23. other
  24. deprecation
  25. worker
  26. # Message severity.
  27. enum level
  28. log
  29. warning
  30. error
  31. debug
  32. info
  33. # Message text.
  34. string text
  35. # URL of the message origin.
  36. optional string url
  37. # Line number in the resource that generated this message (1-based).
  38. optional integer line
  39. # Column number in the resource that generated this message (1-based).
  40. optional integer column
  41. # Does nothing.
  42. command clearMessages
  43. # Disables console domain, prevents further console messages from being reported to the client.
  44. command disable
  45. # Enables console domain, sends the messages collected so far to the client by means of the
  46. # `messageAdded` notification.
  47. command enable
  48. # Issued when new console message is added.
  49. event messageAdded
  50. parameters
  51. # Console message that has been added.
  52. ConsoleMessage message
  53. # Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing
  54. # breakpoints, stepping through execution, exploring stack traces, etc.
  55. domain Debugger
  56. depends on Runtime
  57. # Breakpoint identifier.
  58. type BreakpointId extends string
  59. # Call frame identifier.
  60. type CallFrameId extends string
  61. # Location in the source code.
  62. type Location extends object
  63. properties
  64. # Script identifier as reported in the `Debugger.scriptParsed`.
  65. Runtime.ScriptId scriptId
  66. # Line number in the script (0-based).
  67. integer lineNumber
  68. # Column number in the script (0-based).
  69. optional integer columnNumber
  70. # Location in the source code.
  71. experimental type ScriptPosition extends object
  72. properties
  73. integer lineNumber
  74. integer columnNumber
  75. # Location range within one script.
  76. experimental type LocationRange extends object
  77. properties
  78. Runtime.ScriptId scriptId
  79. ScriptPosition start
  80. ScriptPosition end
  81. # JavaScript call frame. Array of call frames form the call stack.
  82. type CallFrame extends object
  83. properties
  84. # Call frame identifier. This identifier is only valid while the virtual machine is paused.
  85. CallFrameId callFrameId
  86. # Name of the JavaScript function called on this call frame.
  87. string functionName
  88. # Location in the source code.
  89. optional Location functionLocation
  90. # Location in the source code.
  91. Location location
  92. # JavaScript script name or url.
  93. string url
  94. # Scope chain for this call frame.
  95. array of Scope scopeChain
  96. # `this` object for this call frame.
  97. Runtime.RemoteObject this
  98. # The value being returned, if the function is at return point.
  99. optional Runtime.RemoteObject returnValue
  100. # Scope description.
  101. type Scope extends object
  102. properties
  103. # Scope type.
  104. enum type
  105. global
  106. local
  107. with
  108. closure
  109. catch
  110. block
  111. script
  112. eval
  113. module
  114. wasm-expression-stack
  115. # Object representing the scope. For `global` and `with` scopes it represents the actual
  116. # object; for the rest of the scopes, it is artificial transient object enumerating scope
  117. # variables as its properties.
  118. Runtime.RemoteObject object
  119. optional string name
  120. # Location in the source code where scope starts
  121. optional Location startLocation
  122. # Location in the source code where scope ends
  123. optional Location endLocation
  124. # Search match for resource.
  125. type SearchMatch extends object
  126. properties
  127. # Line number in resource content.
  128. number lineNumber
  129. # Line with match content.
  130. string lineContent
  131. type BreakLocation extends object
  132. properties
  133. # Script identifier as reported in the `Debugger.scriptParsed`.
  134. Runtime.ScriptId scriptId
  135. # Line number in the script (0-based).
  136. integer lineNumber
  137. # Column number in the script (0-based).
  138. optional integer columnNumber
  139. optional enum type
  140. debuggerStatement
  141. call
  142. return
  143. # Continues execution until specific location is reached.
  144. command continueToLocation
  145. parameters
  146. # Location to continue to.
  147. Location location
  148. optional enum targetCallFrames
  149. any
  150. current
  151. # Disables debugger for given page.
  152. command disable
  153. # Enables debugger for the given page. Clients should not assume that the debugging has been
  154. # enabled until the result for this command is received.
  155. command enable
  156. parameters
  157. # The maximum size in bytes of collected scripts (not referenced by other heap objects)
  158. # the debugger can hold. Puts no limit if paramter is omitted.
  159. experimental optional number maxScriptsCacheSize
  160. returns
  161. # Unique identifier of the debugger.
  162. experimental Runtime.UniqueDebuggerId debuggerId
  163. # Evaluates expression on a given call frame.
  164. command evaluateOnCallFrame
  165. parameters
  166. # Call frame identifier to evaluate on.
  167. CallFrameId callFrameId
  168. # Expression to evaluate.
  169. string expression
  170. # String object group name to put result into (allows rapid releasing resulting object handles
  171. # using `releaseObjectGroup`).
  172. optional string objectGroup
  173. # Specifies whether command line API should be available to the evaluated expression, defaults
  174. # to false.
  175. optional boolean includeCommandLineAPI
  176. # In silent mode exceptions thrown during evaluation are not reported and do not pause
  177. # execution. Overrides `setPauseOnException` state.
  178. optional boolean silent
  179. # Whether the result is expected to be a JSON object that should be sent by value.
  180. optional boolean returnByValue
  181. # Whether preview should be generated for the result.
  182. experimental optional boolean generatePreview
  183. # Whether to throw an exception if side effect cannot be ruled out during evaluation.
  184. optional boolean throwOnSideEffect
  185. # Terminate execution after timing out (number of milliseconds).
  186. experimental optional Runtime.TimeDelta timeout
  187. returns
  188. # Object wrapper for the evaluation result.
  189. Runtime.RemoteObject result
  190. # Exception details.
  191. optional Runtime.ExceptionDetails exceptionDetails
  192. # Execute a Wasm Evaluator module on a given call frame.
  193. experimental command executeWasmEvaluator
  194. parameters
  195. # WebAssembly call frame identifier to evaluate on.
  196. CallFrameId callFrameId
  197. # Code of the evaluator module.
  198. binary evaluator
  199. # Terminate execution after timing out (number of milliseconds).
  200. experimental optional Runtime.TimeDelta timeout
  201. returns
  202. # Object wrapper for the evaluation result.
  203. Runtime.RemoteObject result
  204. # Exception details.
  205. optional Runtime.ExceptionDetails exceptionDetails
  206. # Returns possible locations for breakpoint. scriptId in start and end range locations should be
  207. # the same.
  208. command getPossibleBreakpoints
  209. parameters
  210. # Start of range to search possible breakpoint locations in.
  211. Location start
  212. # End of range to search possible breakpoint locations in (excluding). When not specified, end
  213. # of scripts is used as end of range.
  214. optional Location end
  215. # Only consider locations which are in the same (non-nested) function as start.
  216. optional boolean restrictToFunction
  217. returns
  218. # List of the possible breakpoint locations.
  219. array of BreakLocation locations
  220. # Returns source for the script with given id.
  221. command getScriptSource
  222. parameters
  223. # Id of the script to get source for.
  224. Runtime.ScriptId scriptId
  225. returns
  226. # Script source (empty in case of Wasm bytecode).
  227. string scriptSource
  228. # Wasm bytecode.
  229. optional binary bytecode
  230. # This command is deprecated. Use getScriptSource instead.
  231. deprecated command getWasmBytecode
  232. parameters
  233. # Id of the Wasm script to get source for.
  234. Runtime.ScriptId scriptId
  235. returns
  236. # Script source.
  237. binary bytecode
  238. # Returns stack trace with given `stackTraceId`.
  239. experimental command getStackTrace
  240. parameters
  241. Runtime.StackTraceId stackTraceId
  242. returns
  243. Runtime.StackTrace stackTrace
  244. # Stops on the next JavaScript statement.
  245. command pause
  246. experimental deprecated command pauseOnAsyncCall
  247. parameters
  248. # Debugger will pause when async call with given stack trace is started.
  249. Runtime.StackTraceId parentStackTraceId
  250. # Removes JavaScript breakpoint.
  251. command removeBreakpoint
  252. parameters
  253. BreakpointId breakpointId
  254. # Restarts particular call frame from the beginning.
  255. command restartFrame
  256. parameters
  257. # Call frame identifier to evaluate on.
  258. CallFrameId callFrameId
  259. returns
  260. # New stack trace.
  261. array of CallFrame callFrames
  262. # Async stack trace, if any.
  263. optional Runtime.StackTrace asyncStackTrace
  264. # Async stack trace, if any.
  265. experimental optional Runtime.StackTraceId asyncStackTraceId
  266. # Resumes JavaScript execution.
  267. command resume
  268. parameters
  269. # Set to true to terminate execution upon resuming execution. In contrast
  270. # to Runtime.terminateExecution, this will allows to execute further
  271. # JavaScript (i.e. via evaluation) until execution of the paused code
  272. # is actually resumed, at which point termination is triggered.
  273. # If execution is currently not paused, this parameter has no effect.
  274. optional boolean terminateOnResume
  275. # Searches for given string in script content.
  276. command searchInContent
  277. parameters
  278. # Id of the script to search in.
  279. Runtime.ScriptId scriptId
  280. # String to search for.
  281. string query
  282. # If true, search is case sensitive.
  283. optional boolean caseSensitive
  284. # If true, treats string parameter as regex.
  285. optional boolean isRegex
  286. returns
  287. # List of search matches.
  288. array of SearchMatch result
  289. # Enables or disables async call stacks tracking.
  290. command setAsyncCallStackDepth
  291. parameters
  292. # Maximum depth of async call stacks. Setting to `0` will effectively disable collecting async
  293. # call stacks (default).
  294. integer maxDepth
  295. # Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in
  296. # scripts with url matching one of the patterns. VM will try to leave blackboxed script by
  297. # performing 'step in' several times, finally resorting to 'step out' if unsuccessful.
  298. experimental command setBlackboxPatterns
  299. parameters
  300. # Array of regexps that will be used to check script url for blackbox state.
  301. array of string patterns
  302. # Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted
  303. # scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.
  304. # Positions array contains positions where blackbox state is changed. First interval isn't
  305. # blackboxed. Array should be sorted.
  306. experimental command setBlackboxedRanges
  307. parameters
  308. # Id of the script.
  309. Runtime.ScriptId scriptId
  310. array of ScriptPosition positions
  311. # Sets JavaScript breakpoint at a given location.
  312. command setBreakpoint
  313. parameters
  314. # Location to set breakpoint in.
  315. Location location
  316. # Expression to use as a breakpoint condition. When specified, debugger will only stop on the
  317. # breakpoint if this expression evaluates to true.
  318. optional string condition
  319. returns
  320. # Id of the created breakpoint for further reference.
  321. BreakpointId breakpointId
  322. # Location this breakpoint resolved into.
  323. Location actualLocation
  324. # Sets instrumentation breakpoint.
  325. command setInstrumentationBreakpoint
  326. parameters
  327. # Instrumentation name.
  328. enum instrumentation
  329. beforeScriptExecution
  330. beforeScriptWithSourceMapExecution
  331. returns
  332. # Id of the created breakpoint for further reference.
  333. BreakpointId breakpointId
  334. # Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this
  335. # command is issued, all existing parsed scripts will have breakpoints resolved and returned in
  336. # `locations` property. Further matching script parsing will result in subsequent
  337. # `breakpointResolved` events issued. This logical breakpoint will survive page reloads.
  338. command setBreakpointByUrl
  339. parameters
  340. # Line number to set breakpoint at.
  341. integer lineNumber
  342. # URL of the resources to set breakpoint on.
  343. optional string url
  344. # Regex pattern for the URLs of the resources to set breakpoints on. Either `url` or
  345. # `urlRegex` must be specified.
  346. optional string urlRegex
  347. # Script hash of the resources to set breakpoint on.
  348. optional string scriptHash
  349. # Offset in the line to set breakpoint at.
  350. optional integer columnNumber
  351. # Expression to use as a breakpoint condition. When specified, debugger will only stop on the
  352. # breakpoint if this expression evaluates to true.
  353. optional string condition
  354. returns
  355. # Id of the created breakpoint for further reference.
  356. BreakpointId breakpointId
  357. # List of the locations this breakpoint resolved into upon addition.
  358. array of Location locations
  359. # Sets JavaScript breakpoint before each call to the given function.
  360. # If another function was created from the same source as a given one,
  361. # calling it will also trigger the breakpoint.
  362. experimental command setBreakpointOnFunctionCall
  363. parameters
  364. # Function object id.
  365. Runtime.RemoteObjectId objectId
  366. # Expression to use as a breakpoint condition. When specified, debugger will
  367. # stop on the breakpoint if this expression evaluates to true.
  368. optional string condition
  369. returns
  370. # Id of the created breakpoint for further reference.
  371. BreakpointId breakpointId
  372. # Activates / deactivates all breakpoints on the page.
  373. command setBreakpointsActive
  374. parameters
  375. # New value for breakpoints active state.
  376. boolean active
  377. # Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or
  378. # no exceptions. Initial pause on exceptions state is `none`.
  379. command setPauseOnExceptions
  380. parameters
  381. # Pause on exceptions mode.
  382. enum state
  383. none
  384. uncaught
  385. all
  386. # Changes return value in top frame. Available only at return break position.
  387. experimental command setReturnValue
  388. parameters
  389. # New return value.
  390. Runtime.CallArgument newValue
  391. # Edits JavaScript source live.
  392. command setScriptSource
  393. parameters
  394. # Id of the script to edit.
  395. Runtime.ScriptId scriptId
  396. # New content of the script.
  397. string scriptSource
  398. # If true the change will not actually be applied. Dry run may be used to get result
  399. # description without actually modifying the code.
  400. optional boolean dryRun
  401. returns
  402. # New stack trace in case editing has happened while VM was stopped.
  403. optional array of CallFrame callFrames
  404. # Whether current call stack was modified after applying the changes.
  405. optional boolean stackChanged
  406. # Async stack trace, if any.
  407. optional Runtime.StackTrace asyncStackTrace
  408. # Async stack trace, if any.
  409. experimental optional Runtime.StackTraceId asyncStackTraceId
  410. # Exception details if any.
  411. optional Runtime.ExceptionDetails exceptionDetails
  412. # Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).
  413. command setSkipAllPauses
  414. parameters
  415. # New value for skip pauses state.
  416. boolean skip
  417. # Changes value of variable in a callframe. Object-based scopes are not supported and must be
  418. # mutated manually.
  419. command setVariableValue
  420. parameters
  421. # 0-based number of scope as was listed in scope chain. Only 'local', 'closure' and 'catch'
  422. # scope types are allowed. Other scopes could be manipulated manually.
  423. integer scopeNumber
  424. # Variable name.
  425. string variableName
  426. # New variable value.
  427. Runtime.CallArgument newValue
  428. # Id of callframe that holds variable.
  429. CallFrameId callFrameId
  430. # Steps into the function call.
  431. command stepInto
  432. parameters
  433. # Debugger will pause on the execution of the first async task which was scheduled
  434. # before next pause.
  435. experimental optional boolean breakOnAsyncCall
  436. # The skipList specifies location ranges that should be skipped on step into.
  437. experimental optional array of LocationRange skipList
  438. # Steps out of the function call.
  439. command stepOut
  440. # Steps over the statement.
  441. command stepOver
  442. parameters
  443. # The skipList specifies location ranges that should be skipped on step over.
  444. experimental optional array of LocationRange skipList
  445. # Fired when breakpoint is resolved to an actual script and location.
  446. event breakpointResolved
  447. parameters
  448. # Breakpoint unique identifier.
  449. BreakpointId breakpointId
  450. # Actual breakpoint location.
  451. Location location
  452. # Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.
  453. event paused
  454. parameters
  455. # Call stack the virtual machine stopped on.
  456. array of CallFrame callFrames
  457. # Pause reason.
  458. enum reason
  459. ambiguous
  460. assert
  461. debugCommand
  462. DOM
  463. EventListener
  464. exception
  465. instrumentation
  466. OOM
  467. other
  468. promiseRejection
  469. XHR
  470. # Object containing break-specific auxiliary properties.
  471. optional object data
  472. # Hit breakpoints IDs
  473. optional array of string hitBreakpoints
  474. # Async stack trace, if any.
  475. optional Runtime.StackTrace asyncStackTrace
  476. # Async stack trace, if any.
  477. experimental optional Runtime.StackTraceId asyncStackTraceId
  478. # Never present, will be removed.
  479. experimental deprecated optional Runtime.StackTraceId asyncCallStackTraceId
  480. # Fired when the virtual machine resumed execution.
  481. event resumed
  482. # Enum of possible script languages.
  483. type ScriptLanguage extends string
  484. enum
  485. JavaScript
  486. WebAssembly
  487. # Debug symbols available for a wasm script.
  488. type DebugSymbols extends object
  489. properties
  490. # Type of the debug symbols.
  491. enum type
  492. None
  493. SourceMap
  494. EmbeddedDWARF
  495. ExternalDWARF
  496. # URL of the external symbol source.
  497. optional string externalURL
  498. # Fired when virtual machine fails to parse the script.
  499. event scriptFailedToParse
  500. parameters
  501. # Identifier of the script parsed.
  502. Runtime.ScriptId scriptId
  503. # URL or name of the script parsed (if any).
  504. string url
  505. # Line offset of the script within the resource with given URL (for script tags).
  506. integer startLine
  507. # Column offset of the script within the resource with given URL.
  508. integer startColumn
  509. # Last line of the script.
  510. integer endLine
  511. # Length of the last line of the script.
  512. integer endColumn
  513. # Specifies script creation context.
  514. Runtime.ExecutionContextId executionContextId
  515. # Content hash of the script.
  516. string hash
  517. # Embedder-specific auxiliary data.
  518. optional object executionContextAuxData
  519. # URL of source map associated with script (if any).
  520. optional string sourceMapURL
  521. # True, if this script has sourceURL.
  522. optional boolean hasSourceURL
  523. # True, if this script is ES6 module.
  524. optional boolean isModule
  525. # This script length.
  526. optional integer length
  527. # JavaScript top stack frame of where the script parsed event was triggered if available.
  528. experimental optional Runtime.StackTrace stackTrace
  529. # If the scriptLanguage is WebAssembly, the code section offset in the module.
  530. experimental optional integer codeOffset
  531. # The language of the script.
  532. experimental optional Debugger.ScriptLanguage scriptLanguage
  533. # The name the embedder supplied for this script.
  534. experimental optional string embedderName
  535. # Fired when virtual machine parses script. This event is also fired for all known and uncollected
  536. # scripts upon enabling debugger.
  537. event scriptParsed
  538. parameters
  539. # Identifier of the script parsed.
  540. Runtime.ScriptId scriptId
  541. # URL or name of the script parsed (if any).
  542. string url
  543. # Line offset of the script within the resource with given URL (for script tags).
  544. integer startLine
  545. # Column offset of the script within the resource with given URL.
  546. integer startColumn
  547. # Last line of the script.
  548. integer endLine
  549. # Length of the last line of the script.
  550. integer endColumn
  551. # Specifies script creation context.
  552. Runtime.ExecutionContextId executionContextId
  553. # Content hash of the script.
  554. string hash
  555. # Embedder-specific auxiliary data.
  556. optional object executionContextAuxData
  557. # True, if this script is generated as a result of the live edit operation.
  558. experimental optional boolean isLiveEdit
  559. # URL of source map associated with script (if any).
  560. optional string sourceMapURL
  561. # True, if this script has sourceURL.
  562. optional boolean hasSourceURL
  563. # True, if this script is ES6 module.
  564. optional boolean isModule
  565. # This script length.
  566. optional integer length
  567. # JavaScript top stack frame of where the script parsed event was triggered if available.
  568. experimental optional Runtime.StackTrace stackTrace
  569. # If the scriptLanguage is WebAssembly, the code section offset in the module.
  570. experimental optional integer codeOffset
  571. # The language of the script.
  572. experimental optional Debugger.ScriptLanguage scriptLanguage
  573. # If the scriptLanguage is WebASsembly, the source of debug symbols for the module.
  574. experimental optional Debugger.DebugSymbols debugSymbols
  575. # The name the embedder supplied for this script.
  576. experimental optional string embedderName
  577. experimental domain HeapProfiler
  578. depends on Runtime
  579. # Heap snapshot object id.
  580. type HeapSnapshotObjectId extends string
  581. # Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes.
  582. type SamplingHeapProfileNode extends object
  583. properties
  584. # Function location.
  585. Runtime.CallFrame callFrame
  586. # Allocations size in bytes for the node excluding children.
  587. number selfSize
  588. # Node id. Ids are unique across all profiles collected between startSampling and stopSampling.
  589. integer id
  590. # Child nodes.
  591. array of SamplingHeapProfileNode children
  592. # A single sample from a sampling profile.
  593. type SamplingHeapProfileSample extends object
  594. properties
  595. # Allocation size in bytes attributed to the sample.
  596. number size
  597. # Id of the corresponding profile tree node.
  598. integer nodeId
  599. # Time-ordered sample ordinal number. It is unique across all profiles retrieved
  600. # between startSampling and stopSampling.
  601. number ordinal
  602. # Sampling profile.
  603. type SamplingHeapProfile extends object
  604. properties
  605. SamplingHeapProfileNode head
  606. array of SamplingHeapProfileSample samples
  607. # Enables console to refer to the node with given id via $x (see Command Line API for more details
  608. # $x functions).
  609. command addInspectedHeapObject
  610. parameters
  611. # Heap snapshot object id to be accessible by means of $x command line API.
  612. HeapSnapshotObjectId heapObjectId
  613. command collectGarbage
  614. command disable
  615. command enable
  616. command getHeapObjectId
  617. parameters
  618. # Identifier of the object to get heap object id for.
  619. Runtime.RemoteObjectId objectId
  620. returns
  621. # Id of the heap snapshot object corresponding to the passed remote object id.
  622. HeapSnapshotObjectId heapSnapshotObjectId
  623. command getObjectByHeapObjectId
  624. parameters
  625. HeapSnapshotObjectId objectId
  626. # Symbolic group name that can be used to release multiple objects.
  627. optional string objectGroup
  628. returns
  629. # Evaluation result.
  630. Runtime.RemoteObject result
  631. command getSamplingProfile
  632. returns
  633. # Return the sampling profile being collected.
  634. SamplingHeapProfile profile
  635. command startSampling
  636. parameters
  637. # Average sample interval in bytes. Poisson distribution is used for the intervals. The
  638. # default value is 32768 bytes.
  639. optional number samplingInterval
  640. command startTrackingHeapObjects
  641. parameters
  642. optional boolean trackAllocations
  643. command stopSampling
  644. returns
  645. # Recorded sampling heap profile.
  646. SamplingHeapProfile profile
  647. command stopTrackingHeapObjects
  648. parameters
  649. # If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken
  650. # when the tracking is stopped.
  651. optional boolean reportProgress
  652. optional boolean treatGlobalObjectsAsRoots
  653. command takeHeapSnapshot
  654. parameters
  655. # If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken.
  656. optional boolean reportProgress
  657. # If true, a raw snapshot without artifical roots will be generated
  658. optional boolean treatGlobalObjectsAsRoots
  659. event addHeapSnapshotChunk
  660. parameters
  661. string chunk
  662. # If heap objects tracking has been started then backend may send update for one or more fragments
  663. event heapStatsUpdate
  664. parameters
  665. # An array of triplets. Each triplet describes a fragment. The first integer is the fragment
  666. # index, the second integer is a total count of objects for the fragment, the third integer is
  667. # a total size of the objects for the fragment.
  668. array of integer statsUpdate
  669. # If heap objects tracking has been started then backend regularly sends a current value for last
  670. # seen object id and corresponding timestamp. If the were changes in the heap since last event
  671. # then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.
  672. event lastSeenObjectId
  673. parameters
  674. integer lastSeenObjectId
  675. number timestamp
  676. event reportHeapSnapshotProgress
  677. parameters
  678. integer done
  679. integer total
  680. optional boolean finished
  681. event resetProfiles
  682. domain Profiler
  683. depends on Runtime
  684. depends on Debugger
  685. # Profile node. Holds callsite information, execution statistics and child nodes.
  686. type ProfileNode extends object
  687. properties
  688. # Unique id of the node.
  689. integer id
  690. # Function location.
  691. Runtime.CallFrame callFrame
  692. # Number of samples where this node was on top of the call stack.
  693. optional integer hitCount
  694. # Child node ids.
  695. optional array of integer children
  696. # The reason of being not optimized. The function may be deoptimized or marked as don't
  697. # optimize.
  698. optional string deoptReason
  699. # An array of source position ticks.
  700. optional array of PositionTickInfo positionTicks
  701. # Profile.
  702. type Profile extends object
  703. properties
  704. # The list of profile nodes. First item is the root node.
  705. array of ProfileNode nodes
  706. # Profiling start timestamp in microseconds.
  707. number startTime
  708. # Profiling end timestamp in microseconds.
  709. number endTime
  710. # Ids of samples top nodes.
  711. optional array of integer samples
  712. # Time intervals between adjacent samples in microseconds. The first delta is relative to the
  713. # profile startTime.
  714. optional array of integer timeDeltas
  715. # Specifies a number of samples attributed to a certain source position.
  716. type PositionTickInfo extends object
  717. properties
  718. # Source line number (1-based).
  719. integer line
  720. # Number of samples attributed to the source line.
  721. integer ticks
  722. # Coverage data for a source range.
  723. type CoverageRange extends object
  724. properties
  725. # JavaScript script source offset for the range start.
  726. integer startOffset
  727. # JavaScript script source offset for the range end.
  728. integer endOffset
  729. # Collected execution count of the source range.
  730. integer count
  731. # Coverage data for a JavaScript function.
  732. type FunctionCoverage extends object
  733. properties
  734. # JavaScript function name.
  735. string functionName
  736. # Source ranges inside the function with coverage data.
  737. array of CoverageRange ranges
  738. # Whether coverage data for this function has block granularity.
  739. boolean isBlockCoverage
  740. # Coverage data for a JavaScript script.
  741. type ScriptCoverage extends object
  742. properties
  743. # JavaScript script id.
  744. Runtime.ScriptId scriptId
  745. # JavaScript script name or url.
  746. string url
  747. # Functions contained in the script that has coverage data.
  748. array of FunctionCoverage functions
  749. # Describes a type collected during runtime.
  750. experimental type TypeObject extends object
  751. properties
  752. # Name of a type collected with type profiling.
  753. string name
  754. # Source offset and types for a parameter or return value.
  755. experimental type TypeProfileEntry extends object
  756. properties
  757. # Source offset of the parameter or end of function for return values.
  758. integer offset
  759. # The types for this parameter or return value.
  760. array of TypeObject types
  761. # Type profile data collected during runtime for a JavaScript script.
  762. experimental type ScriptTypeProfile extends object
  763. properties
  764. # JavaScript script id.
  765. Runtime.ScriptId scriptId
  766. # JavaScript script name or url.
  767. string url
  768. # Type profile entries for parameters and return values of the functions in the script.
  769. array of TypeProfileEntry entries
  770. # Collected counter information.
  771. experimental type CounterInfo extends object
  772. properties
  773. # Counter name.
  774. string name
  775. # Counter value.
  776. integer value
  777. # Runtime call counter information.
  778. experimental type RuntimeCallCounterInfo extends object
  779. properties
  780. # Counter name.
  781. string name
  782. # Counter value.
  783. number value
  784. # Counter time in seconds.
  785. number time
  786. command disable
  787. command enable
  788. # Collect coverage data for the current isolate. The coverage data may be incomplete due to
  789. # garbage collection.
  790. command getBestEffortCoverage
  791. returns
  792. # Coverage data for the current isolate.
  793. array of ScriptCoverage result
  794. # Changes CPU profiler sampling interval. Must be called before CPU profiles recording started.
  795. command setSamplingInterval
  796. parameters
  797. # New sampling interval in microseconds.
  798. integer interval
  799. command start
  800. # Enable precise code coverage. Coverage data for JavaScript executed before enabling precise code
  801. # coverage may be incomplete. Enabling prevents running optimized code and resets execution
  802. # counters.
  803. command startPreciseCoverage
  804. parameters
  805. # Collect accurate call counts beyond simple 'covered' or 'not covered'.
  806. optional boolean callCount
  807. # Collect block-based coverage.
  808. optional boolean detailed
  809. # Allow the backend to send updates on its own initiative
  810. optional boolean allowTriggeredUpdates
  811. returns
  812. # Monotonically increasing time (in seconds) when the coverage update was taken in the backend.
  813. number timestamp
  814. # Enable type profile.
  815. experimental command startTypeProfile
  816. command stop
  817. returns
  818. # Recorded profile.
  819. Profile profile
  820. # Disable precise code coverage. Disabling releases unnecessary execution count records and allows
  821. # executing optimized code.
  822. command stopPreciseCoverage
  823. # Disable type profile. Disabling releases type profile data collected so far.
  824. experimental command stopTypeProfile
  825. # Collect coverage data for the current isolate, and resets execution counters. Precise code
  826. # coverage needs to have started.
  827. command takePreciseCoverage
  828. returns
  829. # Coverage data for the current isolate.
  830. array of ScriptCoverage result
  831. # Monotonically increasing time (in seconds) when the coverage update was taken in the backend.
  832. number timestamp
  833. # Collect type profile.
  834. experimental command takeTypeProfile
  835. returns
  836. # Type profile for all scripts since startTypeProfile() was turned on.
  837. array of ScriptTypeProfile result
  838. # Enable counters collection.
  839. experimental command enableCounters
  840. # Disable counters collection.
  841. experimental command disableCounters
  842. # Retrieve counters.
  843. experimental command getCounters
  844. returns
  845. # Collected counters information.
  846. array of CounterInfo result
  847. # Enable run time call stats collection.
  848. experimental command enableRuntimeCallStats
  849. # Disable run time call stats collection.
  850. experimental command disableRuntimeCallStats
  851. # Retrieve run time call stats.
  852. experimental command getRuntimeCallStats
  853. returns
  854. # Collected runtime call counter information.
  855. array of RuntimeCallCounterInfo result
  856. event consoleProfileFinished
  857. parameters
  858. string id
  859. # Location of console.profileEnd().
  860. Debugger.Location location
  861. Profile profile
  862. # Profile title passed as an argument to console.profile().
  863. optional string title
  864. # Sent when new profile recording is started using console.profile() call.
  865. event consoleProfileStarted
  866. parameters
  867. string id
  868. # Location of console.profile().
  869. Debugger.Location location
  870. # Profile title passed as an argument to console.profile().
  871. optional string title
  872. # Reports coverage delta since the last poll (either from an event like this, or from
  873. # `takePreciseCoverage` for the current isolate. May only be sent if precise code
  874. # coverage has been started. This event can be trigged by the embedder to, for example,
  875. # trigger collection of coverage data immediatelly at a certain point in time.
  876. experimental event preciseCoverageDeltaUpdate
  877. parameters
  878. # Monotonically increasing time (in seconds) when the coverage update was taken in the backend.
  879. number timestamp
  880. # Identifier for distinguishing coverage events.
  881. string occassion
  882. # Coverage data for the current isolate.
  883. array of ScriptCoverage result
  884. # Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects.
  885. # Evaluation results are returned as mirror object that expose object type, string representation
  886. # and unique identifier that can be used for further object reference. Original objects are
  887. # maintained in memory unless they are either explicitly released or are released along with the
  888. # other objects in their object group.
  889. domain Runtime
  890. # Unique script identifier.
  891. type ScriptId extends string
  892. # Unique object identifier.
  893. type RemoteObjectId extends string
  894. # Primitive value which cannot be JSON-stringified. Includes values `-0`, `NaN`, `Infinity`,
  895. # `-Infinity`, and bigint literals.
  896. type UnserializableValue extends string
  897. # Mirror object referencing original JavaScript object.
  898. type RemoteObject extends object
  899. properties
  900. # Object type.
  901. enum type
  902. object
  903. function
  904. undefined
  905. string
  906. number
  907. boolean
  908. symbol
  909. bigint
  910. wasm
  911. # Object subtype hint. Specified for `object` or `wasm` type values only.
  912. optional enum subtype
  913. array
  914. null
  915. node
  916. regexp
  917. date
  918. map
  919. set
  920. weakmap
  921. weakset
  922. iterator
  923. generator
  924. error
  925. proxy
  926. promise
  927. typedarray
  928. arraybuffer
  929. dataview
  930. i32
  931. i64
  932. f32
  933. f64
  934. v128
  935. externref
  936. # Object class (constructor) name. Specified for `object` type values only.
  937. optional string className
  938. # Remote object value in case of primitive values or JSON values (if it was requested).
  939. optional any value
  940. # Primitive value which can not be JSON-stringified does not have `value`, but gets this
  941. # property.
  942. optional UnserializableValue unserializableValue
  943. # String representation of the object.
  944. optional string description
  945. # Unique object identifier (for non-primitive values).
  946. optional RemoteObjectId objectId
  947. # Preview containing abbreviated property values. Specified for `object` type values only.
  948. experimental optional ObjectPreview preview
  949. experimental optional CustomPreview customPreview
  950. experimental type CustomPreview extends object
  951. properties
  952. # The JSON-stringified result of formatter.header(object, config) call.
  953. # It contains json ML array that represents RemoteObject.
  954. string header
  955. # If formatter returns true as a result of formatter.hasBody call then bodyGetterId will
  956. # contain RemoteObjectId for the function that returns result of formatter.body(object, config) call.
  957. # The result value is json ML array.
  958. optional RemoteObjectId bodyGetterId
  959. # Object containing abbreviated remote object value.
  960. experimental type ObjectPreview extends object
  961. properties
  962. # Object type.
  963. enum type
  964. object
  965. function
  966. undefined
  967. string
  968. number
  969. boolean
  970. symbol
  971. bigint
  972. # Object subtype hint. Specified for `object` type values only.
  973. optional enum subtype
  974. array
  975. null
  976. node
  977. regexp
  978. date
  979. map
  980. set
  981. weakmap
  982. weakset
  983. iterator
  984. generator
  985. error
  986. # String representation of the object.
  987. optional string description
  988. # True iff some of the properties or entries of the original object did not fit.
  989. boolean overflow
  990. # List of the properties.
  991. array of PropertyPreview properties
  992. # List of the entries. Specified for `map` and `set` subtype values only.
  993. optional array of EntryPreview entries
  994. experimental type PropertyPreview extends object
  995. properties
  996. # Property name.
  997. string name
  998. # Object type. Accessor means that the property itself is an accessor property.
  999. enum type
  1000. object
  1001. function
  1002. undefined
  1003. string
  1004. number
  1005. boolean
  1006. symbol
  1007. accessor
  1008. bigint
  1009. # User-friendly property value string.
  1010. optional string value
  1011. # Nested value preview.
  1012. optional ObjectPreview valuePreview
  1013. # Object subtype hint. Specified for `object` type values only.
  1014. optional enum subtype
  1015. array
  1016. null
  1017. node
  1018. regexp
  1019. date
  1020. map
  1021. set
  1022. weakmap
  1023. weakset
  1024. iterator
  1025. generator
  1026. error
  1027. experimental type EntryPreview extends object
  1028. properties
  1029. # Preview of the key. Specified for map-like collection entries.
  1030. optional ObjectPreview key
  1031. # Preview of the value.
  1032. ObjectPreview value
  1033. # Object property descriptor.
  1034. type PropertyDescriptor extends object
  1035. properties
  1036. # Property name or symbol description.
  1037. string name
  1038. # The value associated with the property.
  1039. optional RemoteObject value
  1040. # True if the value associated with the property may be changed (data descriptors only).
  1041. optional boolean writable
  1042. # A function which serves as a getter for the property, or `undefined` if there is no getter
  1043. # (accessor descriptors only).
  1044. optional RemoteObject get
  1045. # A function which serves as a setter for the property, or `undefined` if there is no setter
  1046. # (accessor descriptors only).
  1047. optional RemoteObject set
  1048. # True if the type of this property descriptor may be changed and if the property may be
  1049. # deleted from the corresponding object.
  1050. boolean configurable
  1051. # True if this property shows up during enumeration of the properties on the corresponding
  1052. # object.
  1053. boolean enumerable
  1054. # True if the result was thrown during the evaluation.
  1055. optional boolean wasThrown
  1056. # True if the property is owned for the object.
  1057. optional boolean isOwn
  1058. # Property symbol object, if the property is of the `symbol` type.
  1059. optional RemoteObject symbol
  1060. # Object internal property descriptor. This property isn't normally visible in JavaScript code.
  1061. type InternalPropertyDescriptor extends object
  1062. properties
  1063. # Conventional property name.
  1064. string name
  1065. # The value associated with the property.
  1066. optional RemoteObject value
  1067. # Object private field descriptor.
  1068. experimental type PrivatePropertyDescriptor extends object
  1069. properties
  1070. # Private property name.
  1071. string name
  1072. # The value associated with the private property.
  1073. optional RemoteObject value
  1074. # A function which serves as a getter for the private property,
  1075. # or `undefined` if there is no getter (accessor descriptors only).
  1076. optional RemoteObject get
  1077. # A function which serves as a setter for the private property,
  1078. # or `undefined` if there is no setter (accessor descriptors only).
  1079. optional RemoteObject set
  1080. # Represents function call argument. Either remote object id `objectId`, primitive `value`,
  1081. # unserializable primitive value or neither of (for undefined) them should be specified.
  1082. type CallArgument extends object
  1083. properties
  1084. # Primitive value or serializable javascript object.
  1085. optional any value
  1086. # Primitive value which can not be JSON-stringified.
  1087. optional UnserializableValue unserializableValue
  1088. # Remote object handle.
  1089. optional RemoteObjectId objectId
  1090. # Id of an execution context.
  1091. type ExecutionContextId extends integer
  1092. # Description of an isolated world.
  1093. type ExecutionContextDescription extends object
  1094. properties
  1095. # Unique id of the execution context. It can be used to specify in which execution context
  1096. # script evaluation should be performed.
  1097. ExecutionContextId id
  1098. # Execution context origin.
  1099. string origin
  1100. # Human readable name describing given context.
  1101. string name
  1102. # Embedder-specific auxiliary data.
  1103. optional object auxData
  1104. # Detailed information about exception (or error) that was thrown during script compilation or
  1105. # execution.
  1106. type ExceptionDetails extends object
  1107. properties
  1108. # Exception id.
  1109. integer exceptionId
  1110. # Exception text, which should be used together with exception object when available.
  1111. string text
  1112. # Line number of the exception location (0-based).
  1113. integer lineNumber
  1114. # Column number of the exception location (0-based).
  1115. integer columnNumber
  1116. # Script ID of the exception location.
  1117. optional ScriptId scriptId
  1118. # URL of the exception location, to be used when the script was not reported.
  1119. optional string url
  1120. # JavaScript stack trace if available.
  1121. optional StackTrace stackTrace
  1122. # Exception object if available.
  1123. optional RemoteObject exception
  1124. # Identifier of the context where exception happened.
  1125. optional ExecutionContextId executionContextId
  1126. # Number of milliseconds since epoch.
  1127. type Timestamp extends number
  1128. # Number of milliseconds.
  1129. type TimeDelta extends number
  1130. # Stack entry for runtime errors and assertions.
  1131. type CallFrame extends object
  1132. properties
  1133. # JavaScript function name.
  1134. string functionName
  1135. # JavaScript script id.
  1136. ScriptId scriptId
  1137. # JavaScript script name or url.
  1138. string url
  1139. # JavaScript script line number (0-based).
  1140. integer lineNumber
  1141. # JavaScript script column number (0-based).
  1142. integer columnNumber
  1143. # Call frames for assertions or error messages.
  1144. type StackTrace extends object
  1145. properties
  1146. # String label of this stack trace. For async traces this may be a name of the function that
  1147. # initiated the async call.
  1148. optional string description
  1149. # JavaScript function name.
  1150. array of CallFrame callFrames
  1151. # Asynchronous JavaScript stack trace that preceded this stack, if available.
  1152. optional StackTrace parent
  1153. # Asynchronous JavaScript stack trace that preceded this stack, if available.
  1154. experimental optional StackTraceId parentId
  1155. # Unique identifier of current debugger.
  1156. experimental type UniqueDebuggerId extends string
  1157. # If `debuggerId` is set stack trace comes from another debugger and can be resolved there. This
  1158. # allows to track cross-debugger calls. See `Runtime.StackTrace` and `Debugger.paused` for usages.
  1159. experimental type StackTraceId extends object
  1160. properties
  1161. string id
  1162. optional UniqueDebuggerId debuggerId
  1163. # Add handler to promise with given promise object id.
  1164. command awaitPromise
  1165. parameters
  1166. # Identifier of the promise.
  1167. RemoteObjectId promiseObjectId
  1168. # Whether the result is expected to be a JSON object that should be sent by value.
  1169. optional boolean returnByValue
  1170. # Whether preview should be generated for the result.
  1171. optional boolean generatePreview
  1172. returns
  1173. # Promise result. Will contain rejected value if promise was rejected.
  1174. RemoteObject result
  1175. # Exception details if stack strace is available.
  1176. optional ExceptionDetails exceptionDetails
  1177. # Calls function with given declaration on the given object. Object group of the result is
  1178. # inherited from the target object.
  1179. command callFunctionOn
  1180. parameters
  1181. # Declaration of the function to call.
  1182. string functionDeclaration
  1183. # Identifier of the object to call function on. Either objectId or executionContextId should
  1184. # be specified.
  1185. optional RemoteObjectId objectId
  1186. # Call arguments. All call arguments must belong to the same JavaScript world as the target
  1187. # object.
  1188. optional array of CallArgument arguments
  1189. # In silent mode exceptions thrown during evaluation are not reported and do not pause
  1190. # execution. Overrides `setPauseOnException` state.
  1191. optional boolean silent
  1192. # Whether the result is expected to be a JSON object which should be sent by value.
  1193. optional boolean returnByValue
  1194. # Whether preview should be generated for the result.
  1195. experimental optional boolean generatePreview
  1196. # Whether execution should be treated as initiated by user in the UI.
  1197. optional boolean userGesture
  1198. # Whether execution should `await` for resulting value and return once awaited promise is
  1199. # resolved.
  1200. optional boolean awaitPromise
  1201. # Specifies execution context which global object will be used to call function on. Either
  1202. # executionContextId or objectId should be specified.
  1203. optional ExecutionContextId executionContextId
  1204. # Symbolic group name that can be used to release multiple objects. If objectGroup is not
  1205. # specified and objectId is, objectGroup will be inherited from object.
  1206. optional string objectGroup
  1207. returns
  1208. # Call result.
  1209. RemoteObject result
  1210. # Exception details.
  1211. optional ExceptionDetails exceptionDetails
  1212. # Compiles expression.
  1213. command compileScript
  1214. parameters
  1215. # Expression to compile.
  1216. string expression
  1217. # Source url to be set for the script.
  1218. string sourceURL
  1219. # Specifies whether the compiled script should be persisted.
  1220. boolean persistScript
  1221. # Specifies in which execution context to perform script run. If the parameter is omitted the
  1222. # evaluation will be performed in the context of the inspected page.
  1223. optional ExecutionContextId executionContextId
  1224. returns
  1225. # Id of the script.
  1226. optional ScriptId scriptId
  1227. # Exception details.
  1228. optional ExceptionDetails exceptionDetails
  1229. # Disables reporting of execution contexts creation.
  1230. command disable
  1231. # Discards collected exceptions and console API calls.
  1232. command discardConsoleEntries
  1233. # Enables reporting of execution contexts creation by means of `executionContextCreated` event.
  1234. # When the reporting gets enabled the event will be sent immediately for each existing execution
  1235. # context.
  1236. command enable
  1237. # Evaluates expression on global object.
  1238. command evaluate
  1239. parameters
  1240. # Expression to evaluate.
  1241. string expression
  1242. # Symbolic group name that can be used to release multiple objects.
  1243. optional string objectGroup
  1244. # Determines whether Command Line API should be available during the evaluation.
  1245. optional boolean includeCommandLineAPI
  1246. # In silent mode exceptions thrown during evaluation are not reported and do not pause
  1247. # execution. Overrides `setPauseOnException` state.
  1248. optional boolean silent
  1249. # Specifies in which execution context to perform evaluation. If the parameter is omitted the
  1250. # evaluation will be performed in the context of the inspected page.
  1251. optional ExecutionContextId contextId
  1252. # Whether the result is expected to be a JSON object that should be sent by value.
  1253. optional boolean returnByValue
  1254. # Whether preview should be generated for the result.
  1255. experimental optional boolean generatePreview
  1256. # Whether execution should be treated as initiated by user in the UI.
  1257. optional boolean userGesture
  1258. # Whether execution should `await` for resulting value and return once awaited promise is
  1259. # resolved.
  1260. optional boolean awaitPromise
  1261. # Whether to throw an exception if side effect cannot be ruled out during evaluation.
  1262. # This implies `disableBreaks` below.
  1263. experimental optional boolean throwOnSideEffect
  1264. # Terminate execution after timing out (number of milliseconds).
  1265. experimental optional TimeDelta timeout
  1266. # Disable breakpoints during execution.
  1267. experimental optional boolean disableBreaks
  1268. # Setting this flag to true enables `let` re-declaration and top-level `await`.
  1269. # Note that `let` variables can only be re-declared if they originate from
  1270. # `replMode` themselves.
  1271. experimental optional boolean replMode
  1272. # The Content Security Policy (CSP) for the target might block 'unsafe-eval'
  1273. # which includes eval(), Function(), setTimeout() and setInterval()
  1274. # when called with non-callable arguments. This flag bypasses CSP for this
  1275. # evaluation and allows unsafe-eval. Defaults to true.
  1276. experimental optional boolean allowUnsafeEvalBlockedByCSP
  1277. returns
  1278. # Evaluation result.
  1279. RemoteObject result
  1280. # Exception details.
  1281. optional ExceptionDetails exceptionDetails
  1282. # Returns the isolate id.
  1283. experimental command getIsolateId
  1284. returns
  1285. # The isolate id.
  1286. string id
  1287. # Returns the JavaScript heap usage.
  1288. # It is the total usage of the corresponding isolate not scoped to a particular Runtime.
  1289. experimental command getHeapUsage
  1290. returns
  1291. # Used heap size in bytes.
  1292. number usedSize
  1293. # Allocated heap size in bytes.
  1294. number totalSize
  1295. # Returns properties of a given object. Object group of the result is inherited from the target
  1296. # object.
  1297. command getProperties
  1298. parameters
  1299. # Identifier of the object to return properties for.
  1300. RemoteObjectId objectId
  1301. # If true, returns properties belonging only to the element itself, not to its prototype
  1302. # chain.
  1303. optional boolean ownProperties
  1304. # If true, returns accessor properties (with getter/setter) only; internal properties are not
  1305. # returned either.
  1306. experimental optional boolean accessorPropertiesOnly
  1307. # Whether preview should be generated for the results.
  1308. experimental optional boolean generatePreview
  1309. returns
  1310. # Object properties.
  1311. array of PropertyDescriptor result
  1312. # Internal object properties (only of the element itself).
  1313. optional array of InternalPropertyDescriptor internalProperties
  1314. # Object private properties.
  1315. experimental optional array of PrivatePropertyDescriptor privateProperties
  1316. # Exception details.
  1317. optional ExceptionDetails exceptionDetails
  1318. # Returns all let, const and class variables from global scope.
  1319. command globalLexicalScopeNames
  1320. parameters
  1321. # Specifies in which execution context to lookup global scope variables.
  1322. optional ExecutionContextId executionContextId
  1323. returns
  1324. array of string names
  1325. command queryObjects
  1326. parameters
  1327. # Identifier of the prototype to return objects for.
  1328. RemoteObjectId prototypeObjectId
  1329. # Symbolic group name that can be used to release the results.
  1330. optional string objectGroup
  1331. returns
  1332. # Array with objects.
  1333. RemoteObject objects
  1334. # Releases remote object with given id.
  1335. command releaseObject
  1336. parameters
  1337. # Identifier of the object to release.
  1338. RemoteObjectId objectId
  1339. # Releases all remote objects that belong to a given group.
  1340. command releaseObjectGroup
  1341. parameters
  1342. # Symbolic object group name.
  1343. string objectGroup
  1344. # Tells inspected instance to run if it was waiting for debugger to attach.
  1345. command runIfWaitingForDebugger
  1346. # Runs script with given id in a given context.
  1347. command runScript
  1348. parameters
  1349. # Id of the script to run.
  1350. ScriptId scriptId
  1351. # Specifies in which execution context to perform script run. If the parameter is omitted the
  1352. # evaluation will be performed in the context of the inspected page.
  1353. optional ExecutionContextId executionContextId
  1354. # Symbolic group name that can be used to release multiple objects.
  1355. optional string objectGroup
  1356. # In silent mode exceptions thrown during evaluation are not reported and do not pause
  1357. # execution. Overrides `setPauseOnException` state.
  1358. optional boolean silent
  1359. # Determines whether Command Line API should be available during the evaluation.
  1360. optional boolean includeCommandLineAPI
  1361. # Whether the result is expected to be a JSON object which should be sent by value.
  1362. optional boolean returnByValue
  1363. # Whether preview should be generated for the result.
  1364. optional boolean generatePreview
  1365. # Whether execution should `await` for resulting value and return once awaited promise is
  1366. # resolved.
  1367. optional boolean awaitPromise
  1368. returns
  1369. # Run result.
  1370. RemoteObject result
  1371. # Exception details.
  1372. optional ExceptionDetails exceptionDetails
  1373. # Enables or disables async call stacks tracking.
  1374. command setAsyncCallStackDepth
  1375. redirect Debugger
  1376. parameters
  1377. # Maximum depth of async call stacks. Setting to `0` will effectively disable collecting async
  1378. # call stacks (default).
  1379. integer maxDepth
  1380. experimental command setCustomObjectFormatterEnabled
  1381. parameters
  1382. boolean enabled
  1383. experimental command setMaxCallStackSizeToCapture
  1384. parameters
  1385. integer size
  1386. # Terminate current or next JavaScript execution.
  1387. # Will cancel the termination when the outer-most script execution ends.
  1388. experimental command terminateExecution
  1389. # If executionContextId is empty, adds binding with the given name on the
  1390. # global objects of all inspected contexts, including those created later,
  1391. # bindings survive reloads.
  1392. # If executionContextId is specified, adds binding only on global object of
  1393. # given execution context.
  1394. # Binding function takes exactly one argument, this argument should be string,
  1395. # in case of any other input, function throws an exception.
  1396. # Each binding function call produces Runtime.bindingCalled notification.
  1397. experimental command addBinding
  1398. parameters
  1399. string name
  1400. optional ExecutionContextId executionContextId
  1401. # This method does not remove binding function from global object but
  1402. # unsubscribes current runtime agent from Runtime.bindingCalled notifications.
  1403. experimental command removeBinding
  1404. parameters
  1405. string name
  1406. # Notification is issued every time when binding is called.
  1407. experimental event bindingCalled
  1408. parameters
  1409. string name
  1410. string payload
  1411. # Identifier of the context where the call was made.
  1412. ExecutionContextId executionContextId
  1413. # Issued when console API was called.
  1414. event consoleAPICalled
  1415. parameters
  1416. # Type of the call.
  1417. enum type
  1418. log
  1419. debug
  1420. info
  1421. error
  1422. warning
  1423. dir
  1424. dirxml
  1425. table
  1426. trace
  1427. clear
  1428. startGroup
  1429. startGroupCollapsed
  1430. endGroup
  1431. assert
  1432. profile
  1433. profileEnd
  1434. count
  1435. timeEnd
  1436. # Call arguments.
  1437. array of RemoteObject args
  1438. # Identifier of the context where the call was made.
  1439. ExecutionContextId executionContextId
  1440. # Call timestamp.
  1441. Timestamp timestamp
  1442. # Stack trace captured when the call was made. The async stack chain is automatically reported for
  1443. # the following call types: `assert`, `error`, `trace`, `warning`. For other types the async call
  1444. # chain can be retrieved using `Debugger.getStackTrace` and `stackTrace.parentId` field.
  1445. optional StackTrace stackTrace
  1446. # Console context descriptor for calls on non-default console context (not console.*):
  1447. # 'anonymous#unique-logger-id' for call on unnamed context, 'name#unique-logger-id' for call
  1448. # on named context.
  1449. experimental optional string context
  1450. # Issued when unhandled exception was revoked.
  1451. event exceptionRevoked
  1452. parameters
  1453. # Reason describing why exception was revoked.
  1454. string reason
  1455. # The id of revoked exception, as reported in `exceptionThrown`.
  1456. integer exceptionId
  1457. # Issued when exception was thrown and unhandled.
  1458. event exceptionThrown
  1459. parameters
  1460. # Timestamp of the exception.
  1461. Timestamp timestamp
  1462. ExceptionDetails exceptionDetails
  1463. # Issued when new execution context is created.
  1464. event executionContextCreated
  1465. parameters
  1466. # A newly created execution context.
  1467. ExecutionContextDescription context
  1468. # Issued when execution context is destroyed.
  1469. event executionContextDestroyed
  1470. parameters
  1471. # Id of the destroyed context
  1472. ExecutionContextId executionContextId
  1473. # Issued when all executionContexts were cleared in browser
  1474. event executionContextsCleared
  1475. # Issued when object should be inspected (for example, as a result of inspect() command line API
  1476. # call).
  1477. event inspectRequested
  1478. parameters
  1479. RemoteObject object
  1480. object hints
  1481. # This domain is deprecated.
  1482. deprecated domain Schema
  1483. # Description of the protocol domain.
  1484. type Domain extends object
  1485. properties
  1486. # Domain name.
  1487. string name
  1488. # Domain version.
  1489. string version
  1490. # Returns supported domains.
  1491. command getDomains
  1492. returns
  1493. # List of supported domains.
  1494. array of Domain domains