├── README.md ├── docs ├── deviceorientation.md ├── inspector.md ├── schema.md ├── tethering.md ├── audits.md ├── memory.md ├── performance.md ├── console.md ├── io.md ├── systeminfo.md ├── log.md ├── database.md ├── headlessexperimental.md ├── storage.md ├── tracing.md ├── browser.md ├── applicationcache.md ├── domstorage.md ├── domdebugger.md ├── cachestorage.md ├── serviceworker.md ├── animation.md ├── indexeddb.md ├── security.md ├── heapprofiler.md ├── domsnapshot.md ├── overlay.md ├── accessibility.md ├── emulation.md ├── profiler.md ├── input.md ├── layertree.md └── target.md ├── pdl.sublime-syntax ├── convert.js ├── parse.py └── parse.js /README.md: -------------------------------------------------------------------------------- 1 | # pdl 2 | -------------------------------------------------------------------------------- /docs/deviceorientation.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: DeviceOrientation 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: DeviceOrientation.clearDeviceOrientationOverride 8 | 9 | Clears the overridden Device Orientation. 10 | 11 | --- 12 | 13 | 14 | #### command: DeviceOrientation.setDeviceOrientationOverride 15 | 16 | Overrides the Device Orientation. 17 | 18 | *parameters* 19 | - `alpha` <[number]> Mock alpha 20 | - `beta` <[number]> Mock beta 21 | - `gamma` <[number]> Mock gamma 22 | 23 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 24 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 25 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 26 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 27 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 28 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/inspector.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Inspector 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: Inspector.disable 8 | 9 | Disables inspector domain notifications. 10 | 11 | --- 12 | 13 | 14 | #### command: Inspector.enable 15 | 16 | Enables inspector domain notifications. 17 | 18 | --- 19 | 20 | 21 | #### event: Inspector.detached 22 | 23 | Fired when remote debugging connection is about to be terminated. Contains detach reason. 24 | 25 | *parameters* 26 | - `reason` <[string]> The reason why connection has been terminated 27 | 28 | --- 29 | 30 | 31 | #### event: Inspector.targetCrashed 32 | 33 | Fired when debugging target has crashed 34 | 35 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 36 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 37 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 38 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 39 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 40 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/schema.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Schema 🍂 3 | 4 | This domain is deprecated. 5 | 6 | --- 7 | 8 | 9 | #### command: Schema.getDomains 10 | 11 | Returns supported domains. 12 | 13 | *returns* 14 | - `domains` List of supported domains 15 | 16 | --- 17 | 18 | 19 | #### type: Schema.Domain 20 | 21 | Description of the protocol domain. 22 | 23 | *base type* 24 | - **object** 25 | 26 | *properties* 27 | - `name` <[string]> Domain name 28 | - `version` <[string]> Domain version 29 | 30 | *returned from command* 31 | - [Schema.getDomains] 32 | 33 | [Schema.getDomains]: schema.md#command-schemagetdomains "Schema.getDomains" 34 | [Schema.Domain]: schema.md#type-schemadomain "Schema.Domain" 35 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 36 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 37 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 38 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 39 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 40 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/tethering.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Tethering 🌱 3 | 4 | The Tethering domain defines methods and events for browser port binding. 5 | 6 | --- 7 | 8 | 9 | #### command: Tethering.bind 10 | 11 | Request browser port binding. 12 | 13 | *parameters* 14 | - `port` <[integer]> Port number to bind 15 | 16 | --- 17 | 18 | 19 | #### command: Tethering.unbind 20 | 21 | Request browser port unbinding. 22 | 23 | *parameters* 24 | - `port` <[integer]> Port number to unbind 25 | 26 | --- 27 | 28 | 29 | #### event: Tethering.accepted 30 | 31 | Informs that port was successfully bound and got a specified connection id. 32 | 33 | *parameters* 34 | - `port` <[integer]> Port number that was successfully bound 35 | - `connectionId` <[string]> Connection id to be used 36 | 37 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 38 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 39 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 40 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 41 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 42 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/audits.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Audits 🌱 3 | 4 | Audits domain allows investigation of page violations and possible improvements. 5 | 6 | --- 7 | 8 | 9 | #### command: Audits.getEncodedResponse 10 | 11 | Returns the response body and size if it were re-encoded with the specified settings. Only 12 | applies to images. 13 | 14 | *parameters* 15 | - `requestId` <[Network.RequestId]> Identifier of the network request to get content for 16 | - `encoding` <[string]> The encoding to use 17 | - *optional* `quality` <[number]> The quality of the encoding (0-1). (defaults to 1) 18 | - *optional* `sizeOnly` <[boolean]> Whether to only return the size information (defaults to false) 19 | 20 | *returns* 21 | - *optional* `body` <[string]> The encoded body as a base64 string. Omitted if sizeOnly is true 22 | - `originalSize` <[integer]> Size before re-encoding 23 | - `encodedSize` <[integer]> Size after re-encoding 24 | 25 | [Network.RequestId]: network.md#type-networkrequestid "Network.RequestId" 26 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 27 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 28 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 29 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 30 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 31 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/memory.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Memory 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: Memory.getDOMCounters 8 | 9 | *returns* 10 | - `documents` <[integer]> 11 | - `nodes` <[integer]> 12 | - `jsEventListeners` <[integer]> 13 | 14 | --- 15 | 16 | 17 | #### command: Memory.prepareForLeakDetection 18 | 19 | --- 20 | 21 | 22 | #### command: Memory.setPressureNotificationsSuppressed 23 | 24 | Enable/disable suppressing memory pressure notifications in all processes. 25 | 26 | *parameters* 27 | - `suppressed` <[boolean]> If true, memory pressure notifications will be suppressed 28 | 29 | --- 30 | 31 | 32 | #### command: Memory.simulatePressureNotification 33 | 34 | Simulate a memory pressure notification in all processes. 35 | 36 | *parameters* 37 | - `level` <[Memory.PressureLevel]> Memory pressure level of the notification 38 | 39 | --- 40 | 41 | 42 | #### type: Memory.PressureLevel 43 | 44 | Memory pressure level. 45 | 46 | *base type* 47 | - **string** 48 | 49 | *accepted by command* 50 | - [Memory.simulatePressureNotification] 51 | 52 | [Memory.simulatePressureNotification]: memory.md#command-memorysimulatepressurenotification "Memory.simulatePressureNotification" 53 | [Memory.PressureLevel]: memory.md#type-memorypressurelevel "Memory.PressureLevel" 54 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 55 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 56 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 57 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 58 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 59 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/performance.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Performance 3 | 4 | --- 5 | 6 | 7 | #### command: Performance.disable 8 | 9 | Disable collecting and reporting metrics. 10 | 11 | --- 12 | 13 | 14 | #### command: Performance.enable 15 | 16 | Enable collecting and reporting metrics. 17 | 18 | --- 19 | 20 | 21 | #### command: Performance.getMetrics 22 | 23 | Retrieve current values of run-time metrics. 24 | 25 | *returns* 26 | - `metrics` Current values for run-time metrics 27 | 28 | --- 29 | 30 | 31 | #### event: Performance.metrics 32 | 33 | Current values of the metrics. 34 | 35 | *parameters* 36 | - `metrics` Current values of the metrics 37 | - `title` <[string]> Timestamp title 38 | 39 | --- 40 | 41 | 42 | #### type: Performance.Metric 43 | 44 | Run-time execution metric. 45 | 46 | *base type* 47 | - **object** 48 | 49 | *properties* 50 | - `name` <[string]> Metric name 51 | - `value` <[number]> Metric value 52 | 53 | *returned from command* 54 | - [Performance.getMetrics] 55 | 56 | *parameter in event* 57 | - [Performance.metrics] 58 | 59 | [Performance.getMetrics]: performance.md#command-performancegetmetrics "Performance.getMetrics" 60 | [Performance.metrics]: performance.md#event-performancemetrics "Performance.metrics" 61 | [Performance.Metric]: performance.md#type-performancemetric "Performance.Metric" 62 | [Performance.Metric]: performance.md#type-performancemetric "Performance.Metric" 63 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 64 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 65 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 66 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 67 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 68 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /pdl.sublime-syntax: -------------------------------------------------------------------------------- 1 | %YAML 1.2 2 | --- 3 | # See http://www.sublimetext.com/docs/3/syntax.html 4 | file_extensions: 5 | - pdl 6 | scope: source.example-c 7 | 8 | contexts: 9 | # The prototype context is prepended to all contexts but those setting 10 | # meta_include_prototype: false. 11 | prototype: 12 | - include: comments 13 | 14 | main: 15 | # The main context is the initial starting point of our syntax. 16 | # Include other contexts from here (or specify them directly). 17 | - include: keywords 18 | - include: numbers 19 | - include: strings 20 | 21 | keywords: 22 | # Keywords are if, else for and while. 23 | # Note that blackslashes don't need to be escaped within single quoted 24 | # strings in YAML. When using single quoted strings, only single quotes 25 | # need to be escaped: this is done by using two single quotes next to each 26 | # other. 27 | - match: '\b(domain|type|command|event|parameters|returns|optional|experimental|enum|extends|properties|deprecated|version|major|minor|redirect|depends on)\b' 28 | scope: keyword.control.example-c 29 | - match: '\b(string|number|integer|boolean|array of)\b' 30 | scope: constant.numeric.example-c 31 | 32 | numbers: 33 | - match: '\b(-)?[0-9.]+\b' 34 | scope: constant.numeric.example-c 35 | 36 | strings: 37 | # Strings begin and end with quotes, and use backslashes as an escape 38 | # character. 39 | - match: '"' 40 | scope: punctuation.definition.string.begin.example-c 41 | push: inside_string 42 | 43 | inside_string: 44 | - meta_include_prototype: false 45 | - meta_scope: string.quoted.double.example-c 46 | - match: '\.' 47 | scope: constant.character.escape.example-c 48 | - match: '"' 49 | scope: punctuation.definition.string.end.example-c 50 | pop: true 51 | 52 | comments: 53 | # Comments begin with a '//' and finish at the end of the line. 54 | - match: '#' 55 | scope: punctuation.definition.comment.example-c 56 | push: 57 | # This is an anonymous context push for brevity. 58 | - meta_scope: comment.line.double-slash.example-c 59 | - match: $\n? 60 | pop: true 61 | -------------------------------------------------------------------------------- /docs/console.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Console 🍂 3 | 4 | This domain is deprecated - use Runtime or Log instead. 5 | 6 | --- 7 | 8 | 9 | #### command: Console.clearMessages 10 | 11 | Does nothing. 12 | 13 | --- 14 | 15 | 16 | #### command: Console.disable 17 | 18 | Disables console domain, prevents further console messages from being reported to the client. 19 | 20 | --- 21 | 22 | 23 | #### command: Console.enable 24 | 25 | Enables console domain, sends the messages collected so far to the client by means of the 26 | `messageAdded` notification. 27 | 28 | --- 29 | 30 | 31 | #### event: Console.messageAdded 32 | 33 | Issued when new console message is added. 34 | 35 | *parameters* 36 | - `message` <[Console.ConsoleMessage]> Console message that has been added 37 | 38 | --- 39 | 40 | 41 | #### type: Console.ConsoleMessage 42 | 43 | Console message. 44 | 45 | *base type* 46 | - **object** 47 | 48 | *properties* 49 | - `source` <[string]> Message source 50 | - `level` <[string]> Message severity 51 | - `text` <[string]> Message text 52 | - *optional* `url` <[string]> URL of the message origin 53 | - *optional* `line` <[integer]> Line number in the resource that generated this message (1-based) 54 | - *optional* `column` <[integer]> Column number in the resource that generated this message (1-based) 55 | 56 | *parameter in event* 57 | - [Console.messageAdded] 58 | 59 | [Console.messageAdded]: console.md#event-consolemessageadded "Console.messageAdded" 60 | [Console.ConsoleMessage]: console.md#type-consoleconsolemessage "Console.ConsoleMessage" 61 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 62 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 63 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 64 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 65 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 66 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/io.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: IO 3 | 4 | Input/Output operations for streams produced by DevTools. 5 | 6 | --- 7 | 8 | 9 | #### command: IO.close 10 | 11 | Close the stream, discard any temporary backing storage. 12 | 13 | *parameters* 14 | - `handle` <[IO.StreamHandle]> Handle of the stream to close 15 | 16 | --- 17 | 18 | 19 | #### command: IO.read 20 | 21 | Read a chunk of the stream 22 | 23 | *parameters* 24 | - `handle` <[IO.StreamHandle]> Handle of the stream to read 25 | - *optional* `offset` <[integer]> Seek to the specified offset before reading (if not specificed, proceed with offset 26 | following the last read) 27 | - *optional* `size` <[integer]> Maximum number of bytes to read (left upon the agent discretion if not specified) 28 | 29 | *returns* 30 | - *optional* `base64Encoded` <[boolean]> Set if the data is base64-encoded 31 | - `data` <[string]> Data that were read 32 | - `eof` <[boolean]> Set if the end-of-file condition occured while reading 33 | 34 | --- 35 | 36 | 37 | #### command: IO.resolveBlob 38 | 39 | Return UUID of Blob object specified by a remote object id. 40 | 41 | *parameters* 42 | - `objectId` <[Runtime.RemoteObjectId]> Object id of a Blob object wrapper 43 | 44 | *returns* 45 | - `uuid` <[string]> UUID of the specified Blob 46 | 47 | --- 48 | 49 | 50 | #### type: IO.StreamHandle 51 | 52 | This is either obtained from another method or specifed as `blob:<uuid>` where 53 | `<uuid>` is an UUID of a Blob. 54 | 55 | *base type* 56 | - **string** 57 | 58 | *accepted by command* 59 | - [IO.close] 60 | - [IO.read] 61 | 62 | *parameter in event* 63 | - [Tracing.tracingComplete] 64 | 65 | [IO.close]: io.md#command-ioclose "IO.close" 66 | [IO.read]: io.md#command-ioread "IO.read" 67 | [Tracing.tracingComplete]: tracing.md#event-tracingtracingcomplete "Tracing.tracingComplete" 68 | [IO.StreamHandle]: io.md#type-iostreamhandle "IO.StreamHandle" 69 | [IO.StreamHandle]: io.md#type-iostreamhandle "IO.StreamHandle" 70 | [Runtime.RemoteObjectId]: runtime.md#type-runtimeremoteobjectid "Runtime.RemoteObjectId" 71 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 72 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 73 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 74 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 75 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 76 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/systeminfo.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: SystemInfo 🌱 3 | 4 | The SystemInfo domain defines methods and events for querying low-level system information. 5 | 6 | --- 7 | 8 | 9 | #### command: SystemInfo.getInfo 10 | 11 | Returns information about the system. 12 | 13 | *returns* 14 | - `gpu` <[SystemInfo.GPUInfo]> Information about the GPUs on the system 15 | - `modelName` <[string]> A platform-dependent description of the model of the machine. On Mac OS, this is, for 16 | example, 'MacBookPro'. Will be the empty string if not supported 17 | - `modelVersion` <[string]> A platform-dependent description of the version of the machine. On Mac OS, this is, for 18 | example, '10.1'. Will be the empty string if not supported 19 | - `commandLine` <[string]> The command line string used to launch the browser. Will be the empty string if not 20 | supported 21 | 22 | --- 23 | 24 | 25 | #### type: SystemInfo.GPUDevice 26 | 27 | Describes a single graphics processor (GPU). 28 | 29 | *base type* 30 | - **object** 31 | 32 | *properties* 33 | - `vendorId` <[number]> PCI ID of the GPU vendor, if available; 0 otherwise 34 | - `deviceId` <[number]> PCI ID of the GPU device, if available; 0 otherwise 35 | - `vendorString` <[string]> String description of the GPU vendor, if the PCI ID is not available 36 | - `deviceString` <[string]> String description of the GPU device, if the PCI ID is not available 37 | 38 | *property of type* 39 | - [SystemInfo.GPUInfo] 40 | 41 | --- 42 | 43 | 44 | #### type: SystemInfo.GPUInfo 45 | 46 | Provides information about the GPU(s) on the system. 47 | 48 | *base type* 49 | - **object** 50 | 51 | *properties* 52 | - `devices` The graphics devices on the system. Element 0 is the primary GPU 53 | - *optional* `auxAttributes` <[object]> An optional dictionary of additional GPU related attributes 54 | - *optional* `featureStatus` <[object]> An optional dictionary of graphics features and their status 55 | - `driverBugWorkarounds` An optional array of GPU driver bug workarounds 56 | 57 | *returned from command* 58 | - [SystemInfo.getInfo] 59 | 60 | [SystemInfo.GPUInfo]: systeminfo.md#type-systeminfogpuinfo "SystemInfo.GPUInfo" 61 | [SystemInfo.getInfo]: systeminfo.md#command-systeminfogetinfo "SystemInfo.getInfo" 62 | [SystemInfo.GPUDevice]: systeminfo.md#type-systeminfogpudevice "SystemInfo.GPUDevice" 63 | [SystemInfo.GPUInfo]: systeminfo.md#type-systeminfogpuinfo "SystemInfo.GPUInfo" 64 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 65 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 66 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 67 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 68 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 69 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/log.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Log 3 | 4 | Provides access to log entries. 5 | 6 | --- 7 | 8 | 9 | #### command: Log.clear 10 | 11 | Clears the log. 12 | 13 | --- 14 | 15 | 16 | #### command: Log.disable 17 | 18 | Disables log domain, prevents further log entries from being reported to the client. 19 | 20 | --- 21 | 22 | 23 | #### command: Log.enable 24 | 25 | Enables log domain, sends the entries collected so far to the client by means of the 26 | `entryAdded` notification. 27 | 28 | --- 29 | 30 | 31 | #### command: Log.startViolationsReport 32 | 33 | start violation reporting. 34 | 35 | *parameters* 36 | - `config` Configuration for violations 37 | 38 | --- 39 | 40 | 41 | #### command: Log.stopViolationsReport 42 | 43 | Stop violation reporting. 44 | 45 | --- 46 | 47 | 48 | #### event: Log.entryAdded 49 | 50 | Issued when new message was logged. 51 | 52 | *parameters* 53 | - `entry` <[Log.LogEntry]> The entry 54 | 55 | --- 56 | 57 | 58 | #### type: Log.LogEntry 59 | 60 | Log entry. 61 | 62 | *base type* 63 | - **object** 64 | 65 | *properties* 66 | - `source` <[string]> Log entry source 67 | - `level` <[string]> Log entry severity 68 | - `text` <[string]> Logged text 69 | - `timestamp` <[Runtime.Timestamp]> Timestamp when this entry was added 70 | - *optional* `url` <[string]> URL of the resource if known 71 | - *optional* `lineNumber` <[integer]> Line number in the resource 72 | - *optional* `stackTrace` <[Runtime.StackTrace]> JavaScript stack trace 73 | - *optional* `networkRequestId` <[Network.RequestId]> Identifier of the network request associated with this entry 74 | - *optional* `workerId` <[string]> Identifier of the worker associated with this entry 75 | - *optional* `args` Call arguments 76 | 77 | *parameter in event* 78 | - [Log.entryAdded] 79 | 80 | --- 81 | 82 | 83 | #### type: Log.ViolationSetting 84 | 85 | Violation configuration setting. 86 | 87 | *base type* 88 | - **object** 89 | 90 | *properties* 91 | - `name` <[string]> Violation type 92 | - `threshold` <[number]> Time threshold to trigger upon 93 | 94 | *accepted by command* 95 | - [Log.startViolationsReport] 96 | 97 | [Log.entryAdded]: log.md#event-logentryadded "Log.entryAdded" 98 | [Log.startViolationsReport]: log.md#command-logstartviolationsreport "Log.startViolationsReport" 99 | [Runtime.Timestamp]: runtime.md#type-runtimetimestamp "Runtime.Timestamp" 100 | [Runtime.StackTrace]: runtime.md#type-runtimestacktrace "Runtime.StackTrace" 101 | [Network.RequestId]: network.md#type-networkrequestid "Network.RequestId" 102 | [Runtime.RemoteObject]: runtime.md#type-runtimeremoteobject "Runtime.RemoteObject" 103 | [Log.ViolationSetting]: log.md#type-logviolationsetting "Log.ViolationSetting" 104 | [Log.LogEntry]: log.md#type-loglogentry "Log.LogEntry" 105 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 106 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 107 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 108 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 109 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 110 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/database.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Database 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: Database.disable 8 | 9 | Disables database tracking, prevents database events from being sent to the client. 10 | 11 | --- 12 | 13 | 14 | #### command: Database.enable 15 | 16 | Enables database tracking, database events will now be delivered to the client. 17 | 18 | --- 19 | 20 | 21 | #### command: Database.executeSQL 22 | 23 | *parameters* 24 | - `databaseId` <[Database.DatabaseId]> 25 | - `query` <[string]> 26 | 27 | *returns* 28 | - *optional* `columnNames` 29 | - *optional* `values` 30 | - *optional* `sqlError` <[Database.Error]> 31 | 32 | --- 33 | 34 | 35 | #### command: Database.getDatabaseTableNames 36 | 37 | *parameters* 38 | - `databaseId` <[Database.DatabaseId]> 39 | 40 | *returns* 41 | - `tableNames` 42 | 43 | --- 44 | 45 | 46 | #### event: Database.addDatabase 47 | 48 | *parameters* 49 | - `database` <[Database.Database]> 50 | 51 | --- 52 | 53 | 54 | #### type: Database.DatabaseId 55 | 56 | Unique identifier of Database object. 57 | 58 | *base type* 59 | - **string** 60 | 61 | *property of type* 62 | - [Database.Database] 63 | 64 | *accepted by command* 65 | - [Database.executeSQL] 66 | - [Database.getDatabaseTableNames] 67 | 68 | --- 69 | 70 | 71 | #### type: Database.Database 72 | 73 | Database object. 74 | 75 | *base type* 76 | - **object** 77 | 78 | *properties* 79 | - `id` <[Database.DatabaseId]> Database ID 80 | - `domain` <[string]> Database domain 81 | - `name` <[string]> Database name 82 | - `version` <[string]> Database version 83 | 84 | *parameter in event* 85 | - [Database.addDatabase] 86 | 87 | --- 88 | 89 | 90 | #### type: Database.Error 91 | 92 | Database error. 93 | 94 | *base type* 95 | - **object** 96 | 97 | *properties* 98 | - `message` <[string]> Error message 99 | - `code` <[integer]> Error code 100 | 101 | *returned from command* 102 | - [Database.executeSQL] 103 | 104 | [Database.Database]: database.md#type-databasedatabase "Database.Database" 105 | [Database.executeSQL]: database.md#command-databaseexecutesql "Database.executeSQL" 106 | [Database.getDatabaseTableNames]: database.md#command-databasegetdatabasetablenames "Database.getDatabaseTableNames" 107 | [Database.addDatabase]: database.md#event-databaseadddatabase "Database.addDatabase" 108 | [Database.executeSQL]: database.md#command-databaseexecutesql "Database.executeSQL" 109 | [Database.DatabaseId]: database.md#type-databasedatabaseid "Database.DatabaseId" 110 | [Database.DatabaseId]: database.md#type-databasedatabaseid "Database.DatabaseId" 111 | [Database.Error]: database.md#type-databaseerror "Database.Error" 112 | [Database.DatabaseId]: database.md#type-databasedatabaseid "Database.DatabaseId" 113 | [Database.Database]: database.md#type-databasedatabase "Database.Database" 114 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 115 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 116 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 117 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 118 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 119 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/headlessexperimental.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: HeadlessExperimental 🌱 3 | 4 | This domain provides experimental commands only supported in headless mode. 5 | 6 | --- 7 | 8 | 9 | #### command: HeadlessExperimental.beginFrame 10 | 11 | Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a 12 | screenshot from the resulting frame. Requires that the target was created with enabled 13 | BeginFrameControl. 14 | 15 | *parameters* 16 | - *optional* `frameTime` <[Runtime.Timestamp]> Timestamp of this BeginFrame (milliseconds since epoch). If not set, the current time will 17 | be used 18 | - *optional* `deadline` <[Runtime.Timestamp]> Deadline of this BeginFrame (milliseconds since epoch). If not set, the deadline will be 19 | calculated from the frameTime and interval 20 | - *optional* `interval` <[number]> The interval between BeginFrames that is reported to the compositor, in milliseconds. 21 | Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds 22 | - *optional* `screenshot` <[HeadlessExperimental.ScreenshotParams]> If set, a screenshot of the frame will be captured and returned in the response. Otherwise, 23 | no screenshot will be captured 24 | 25 | *returns* 26 | - `hasDamage` <[boolean]> Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the 27 | display 28 | - `mainFrameContentUpdated` <[boolean]> Whether the main frame submitted a new display frame in response to this BeginFrame 29 | - *optional* `screenshotData` <[string]> Base64-encoded image data of the screenshot, if one was requested and successfully taken 30 | 31 | --- 32 | 33 | 34 | #### command: HeadlessExperimental.disable 35 | 36 | Disables headless events for the target. 37 | 38 | --- 39 | 40 | 41 | #### command: HeadlessExperimental.enable 42 | 43 | Enables headless events for the target. 44 | 45 | --- 46 | 47 | 48 | #### event: HeadlessExperimental.mainFrameReadyForScreenshots 49 | 50 | Issued when the main frame has first submitted a frame to the browser. May only be fired while a 51 | BeginFrame is in flight. Before this event, screenshotting requests may fail. 52 | 53 | --- 54 | 55 | 56 | #### event: HeadlessExperimental.needsBeginFramesChanged 57 | 58 | Issued when the target starts or stops needing BeginFrames. 59 | 60 | *parameters* 61 | - `needsBeginFrames` <[boolean]> True if BeginFrames are needed, false otherwise 62 | 63 | --- 64 | 65 | 66 | #### type: HeadlessExperimental.ScreenshotParams 67 | 68 | Encoding options for a screenshot. 69 | 70 | *base type* 71 | - **object** 72 | 73 | *properties* 74 | - *optional* `format` <[string]> Image compression format (defaults to png) 75 | - *optional* `quality` <[integer]> Compression quality from range [0..100] (jpeg only) 76 | 77 | *accepted by command* 78 | - [HeadlessExperimental.beginFrame] 79 | 80 | [HeadlessExperimental.beginFrame]: headlessexperimental.md#command-headlessexperimentalbeginframe "HeadlessExperimental.beginFrame" 81 | [Runtime.Timestamp]: runtime.md#type-runtimetimestamp "Runtime.Timestamp" 82 | [HeadlessExperimental.ScreenshotParams]: headlessexperimental.md#type-headlessexperimentalscreenshotparams "HeadlessExperimental.ScreenshotParams" 83 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 84 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 85 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 86 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 87 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 88 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/storage.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Storage 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: Storage.clearDataForOrigin 8 | 9 | Clears storage for origin. 10 | 11 | *parameters* 12 | - `origin` <[string]> Security origin 13 | - `storageTypes` <[string]> Comma separated origin names 14 | 15 | --- 16 | 17 | 18 | #### command: Storage.getUsageAndQuota 19 | 20 | Returns usage and quota in bytes. 21 | 22 | *parameters* 23 | - `origin` <[string]> Security origin 24 | 25 | *returns* 26 | - `usage` <[number]> Storage usage (bytes) 27 | - `quota` <[number]> Storage quota (bytes) 28 | - `usageBreakdown` Storage usage per type (bytes) 29 | 30 | --- 31 | 32 | 33 | #### command: Storage.trackCacheStorageForOrigin 34 | 35 | Registers origin to be notified when an update occurs to its cache storage list. 36 | 37 | *parameters* 38 | - `origin` <[string]> Security origin 39 | 40 | --- 41 | 42 | 43 | #### command: Storage.trackIndexedDBForOrigin 44 | 45 | Registers origin to be notified when an update occurs to its IndexedDB. 46 | 47 | *parameters* 48 | - `origin` <[string]> Security origin 49 | 50 | --- 51 | 52 | 53 | #### command: Storage.untrackCacheStorageForOrigin 54 | 55 | Unregisters origin from receiving notifications for cache storage. 56 | 57 | *parameters* 58 | - `origin` <[string]> Security origin 59 | 60 | --- 61 | 62 | 63 | #### command: Storage.untrackIndexedDBForOrigin 64 | 65 | Unregisters origin from receiving notifications for IndexedDB. 66 | 67 | *parameters* 68 | - `origin` <[string]> Security origin 69 | 70 | --- 71 | 72 | 73 | #### event: Storage.cacheStorageContentUpdated 74 | 75 | A cache's contents have been modified. 76 | 77 | *parameters* 78 | - `origin` <[string]> Origin to update 79 | - `cacheName` <[string]> Name of cache in origin 80 | 81 | --- 82 | 83 | 84 | #### event: Storage.cacheStorageListUpdated 85 | 86 | A cache has been added/deleted. 87 | 88 | *parameters* 89 | - `origin` <[string]> Origin to update 90 | 91 | --- 92 | 93 | 94 | #### event: Storage.indexedDBContentUpdated 95 | 96 | The origin's IndexedDB object store has been modified. 97 | 98 | *parameters* 99 | - `origin` <[string]> Origin to update 100 | - `databaseName` <[string]> Database to update 101 | - `objectStoreName` <[string]> ObjectStore to update 102 | 103 | --- 104 | 105 | 106 | #### event: Storage.indexedDBListUpdated 107 | 108 | The origin's IndexedDB database list has been modified. 109 | 110 | *parameters* 111 | - `origin` <[string]> Origin to update 112 | 113 | --- 114 | 115 | 116 | #### type: Storage.StorageType 117 | 118 | Enum of possible storage types. 119 | 120 | *base type* 121 | - **string** 122 | 123 | *property of type* 124 | - [Storage.UsageForType] 125 | 126 | --- 127 | 128 | 129 | #### type: Storage.UsageForType 130 | 131 | Usage for a storage type. 132 | 133 | *base type* 134 | - **object** 135 | 136 | *properties* 137 | - `storageType` <[Storage.StorageType]> Name of storage type 138 | - `usage` <[number]> Storage usage (bytes) 139 | 140 | *returned from command* 141 | - [Storage.getUsageAndQuota] 142 | 143 | [Storage.UsageForType]: storage.md#type-storageusagefortype "Storage.UsageForType" 144 | [Storage.getUsageAndQuota]: storage.md#command-storagegetusageandquota "Storage.getUsageAndQuota" 145 | [Storage.StorageType]: storage.md#type-storagestoragetype "Storage.StorageType" 146 | [Storage.UsageForType]: storage.md#type-storageusagefortype "Storage.UsageForType" 147 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 148 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 149 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 150 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 151 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 152 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/tracing.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Tracing 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: Tracing.end 8 | 9 | Stop trace events collection. 10 | 11 | --- 12 | 13 | 14 | #### command: Tracing.getCategories 15 | 16 | Gets supported tracing categories. 17 | 18 | *returns* 19 | - `categories` A list of supported tracing categories 20 | 21 | --- 22 | 23 | 24 | #### command: Tracing.recordClockSyncMarker 25 | 26 | Record a clock sync marker in the trace. 27 | 28 | *parameters* 29 | - `syncId` <[string]> The ID of this clock sync marker 30 | 31 | --- 32 | 33 | 34 | #### command: Tracing.requestMemoryDump 35 | 36 | Request a global memory dump. 37 | 38 | *returns* 39 | - `dumpGuid` <[string]> GUID of the resulting global memory dump 40 | - `success` <[boolean]> True iff the global memory dump succeeded 41 | 42 | --- 43 | 44 | 45 | #### command: Tracing.start 46 | 47 | Start trace events collection. 48 | 49 | *parameters* 50 | - *optional* `categories` <[string]> 🍂 Category/tag filter 51 | - *optional* `options` <[string]> 🍂 Tracing options 52 | - *optional* `bufferUsageReportingInterval` <[number]> If set, the agent will issue bufferUsage events at this interval, specified in milliseconds 53 | - *optional* `transferMode` <[string]> Whether to report trace events as series of dataCollected events or to save trace to a 54 | stream (defaults to `ReportEvents`) 55 | - *optional* `traceConfig` <[Tracing.TraceConfig]> 56 | 57 | --- 58 | 59 | 60 | #### event: Tracing.bufferUsage 61 | 62 | *parameters* 63 | - *optional* `percentFull` <[number]> A number in range [0..1] that indicates the used size of event buffer as a fraction of its 64 | total size 65 | - *optional* `eventCount` <[number]> An approximate number of events in the trace log 66 | - *optional* `value` <[number]> A number in range [0..1] that indicates the used size of event buffer as a fraction of its 67 | total size 68 | 69 | --- 70 | 71 | 72 | #### event: Tracing.dataCollected 73 | 74 | Contains an bucket of collected trace events. When tracing is stopped collected events will be 75 | send as a sequence of dataCollected events followed by tracingComplete event. 76 | 77 | *parameters* 78 | - `value` 79 | 80 | --- 81 | 82 | 83 | #### event: Tracing.tracingComplete 84 | 85 | Signals that tracing is stopped and there is no trace buffers pending flush, all data were 86 | delivered via dataCollected events. 87 | 88 | *parameters* 89 | - *optional* `stream` <[IO.StreamHandle]> A handle of the stream that holds resulting trace data 90 | 91 | --- 92 | 93 | 94 | #### type: Tracing.MemoryDumpConfig 95 | 96 | Configuration for memory dump. Used only when "memory-infra" category is enabled. 97 | 98 | *base type* 99 | - **object** 100 | 101 | *property of type* 102 | - [Tracing.TraceConfig] 103 | 104 | --- 105 | 106 | 107 | #### type: Tracing.TraceConfig 108 | 109 | *base type* 110 | - **object** 111 | 112 | *properties* 113 | - *optional* `recordMode` <[string]> Controls how the trace buffer stores data 114 | - *optional* `enableSampling` <[boolean]> Turns on JavaScript stack sampling 115 | - *optional* `enableSystrace` <[boolean]> Turns on system tracing 116 | - *optional* `enableArgumentFilter` <[boolean]> Turns on argument filter 117 | - *optional* `includedCategories` Included category filters 118 | - *optional* `excludedCategories` Excluded category filters 119 | - *optional* `syntheticDelays` Configuration to synthesize the delays in tracing 120 | - *optional* `memoryDumpConfig` <[Tracing.MemoryDumpConfig]> Configuration for memory dump triggers. Used only when "memory-infra" category is enabled 121 | 122 | *accepted by command* 123 | - [Tracing.start] 124 | 125 | [Tracing.TraceConfig]: tracing.md#type-tracingtraceconfig "Tracing.TraceConfig" 126 | [Tracing.start]: tracing.md#command-tracingstart "Tracing.start" 127 | [Tracing.MemoryDumpConfig]: tracing.md#type-tracingmemorydumpconfig "Tracing.MemoryDumpConfig" 128 | [Tracing.TraceConfig]: tracing.md#type-tracingtraceconfig "Tracing.TraceConfig" 129 | [IO.StreamHandle]: io.md#type-iostreamhandle "IO.StreamHandle" 130 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 131 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 132 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 133 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 134 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 135 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/browser.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Browser 3 | 4 | The Browser domain defines methods and events for browser managing. 5 | 6 | --- 7 | 8 | 9 | #### command: Browser.close 10 | 11 | Close browser gracefully. 12 | 13 | --- 14 | 15 | 16 | #### command: Browser.getVersion 17 | 18 | Returns version information. 19 | 20 | *returns* 21 | - `protocolVersion` <[string]> Protocol version 22 | - `product` <[string]> Product name 23 | - `revision` <[string]> Product revision 24 | - `userAgent` <[string]> User-Agent 25 | - `jsVersion` <[string]> V8 version 26 | 27 | --- 28 | 29 | 30 | #### command: Browser.getWindowBounds 🌱 31 | 32 | Get position and size of the browser window. 33 | 34 | *parameters* 35 | - `windowId` <[Browser.WindowID]> Browser window id 36 | 37 | *returns* 38 | - `bounds` <[Browser.Bounds]> Bounds information of the window. When window state is 'minimized', the restored window 39 | position and size are returned 40 | 41 | --- 42 | 43 | 44 | #### command: Browser.getWindowForTarget 🌱 45 | 46 | Get the browser window that contains the devtools target. 47 | 48 | *parameters* 49 | - `targetId` <[Target.TargetID]> Devtools agent host id 50 | 51 | *returns* 52 | - `windowId` <[Browser.WindowID]> Browser window id 53 | - `bounds` <[Browser.Bounds]> Bounds information of the window. When window state is 'minimized', the restored window 54 | position and size are returned 55 | 56 | --- 57 | 58 | 59 | #### command: Browser.setWindowBounds 🌱 60 | 61 | Set position and/or size of the browser window. 62 | 63 | *parameters* 64 | - `windowId` <[Browser.WindowID]> Browser window id 65 | - `bounds` <[Browser.Bounds]> New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined 66 | with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged 67 | 68 | --- 69 | 70 | 71 | #### type: Browser.WindowID 72 | 73 | *base type* 74 | - **integer** 75 | 76 | *accepted by command* 77 | - [Browser.getWindowBounds] 78 | - [Browser.setWindowBounds] 79 | 80 | *returned from command* 81 | - [Browser.getWindowForTarget] 82 | 83 | --- 84 | 85 | 86 | #### type: Browser.WindowState 87 | 88 | The state of the browser window. 89 | 90 | *base type* 91 | - **string** 92 | 93 | *property of type* 94 | - [Browser.Bounds] 95 | 96 | --- 97 | 98 | 99 | #### type: Browser.Bounds 100 | 101 | Browser window bounds information 102 | 103 | *base type* 104 | - **object** 105 | 106 | *properties* 107 | - *optional* `left` <[integer]> The offset from the left edge of the screen to the window in pixels 108 | - *optional* `top` <[integer]> The offset from the top edge of the screen to the window in pixels 109 | - *optional* `width` <[integer]> The window width in pixels 110 | - *optional* `height` <[integer]> The window height in pixels 111 | - *optional* `windowState` <[Browser.WindowState]> The window state. Default to normal 112 | 113 | *returned from command* 114 | - [Browser.getWindowBounds] 115 | - [Browser.getWindowForTarget] 116 | 117 | *accepted by command* 118 | - [Browser.setWindowBounds] 119 | 120 | [Browser.getWindowBounds]: browser.md#command-browsergetwindowbounds "Browser.getWindowBounds" 121 | [Browser.setWindowBounds]: browser.md#command-browsersetwindowbounds "Browser.setWindowBounds" 122 | [Browser.getWindowForTarget]: browser.md#command-browsergetwindowfortarget "Browser.getWindowForTarget" 123 | [Browser.Bounds]: browser.md#type-browserbounds "Browser.Bounds" 124 | [Browser.getWindowBounds]: browser.md#command-browsergetwindowbounds "Browser.getWindowBounds" 125 | [Browser.getWindowForTarget]: browser.md#command-browsergetwindowfortarget "Browser.getWindowForTarget" 126 | [Browser.setWindowBounds]: browser.md#command-browsersetwindowbounds "Browser.setWindowBounds" 127 | [Browser.WindowState]: browser.md#type-browserwindowstate "Browser.WindowState" 128 | [Browser.WindowID]: browser.md#type-browserwindowid "Browser.WindowID" 129 | [Browser.Bounds]: browser.md#type-browserbounds "Browser.Bounds" 130 | [Target.TargetID]: target.md#type-targettargetid "Target.TargetID" 131 | [Browser.WindowID]: browser.md#type-browserwindowid "Browser.WindowID" 132 | [Browser.Bounds]: browser.md#type-browserbounds "Browser.Bounds" 133 | [Browser.WindowID]: browser.md#type-browserwindowid "Browser.WindowID" 134 | [Browser.Bounds]: browser.md#type-browserbounds "Browser.Bounds" 135 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 136 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 137 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 138 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 139 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 140 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /convert.js: -------------------------------------------------------------------------------- 1 | const fs = require('fs') 2 | 3 | convert('browser'); 4 | convert('js'); 5 | 6 | function stringCompare(nameA, nameB) { 7 | if (nameA < nameB) 8 | return -1; 9 | if (nameA > nameB) 10 | return 1; 11 | return 0; 12 | } 13 | 14 | function convert(name) { 15 | fs.readFile(name + '_protocol.json', 'utf8', (err, data) => { 16 | if (err) { 17 | return console.log(err); 18 | } 19 | const protocol = JSON.parse(data); 20 | const result = [`# Copyright 2017 The Chromium Authors. All rights reserved. 21 | # Use of this source code is governed by a BSD-style license that can be 22 | # found in the LICENSE file. 23 | 24 | version 25 | major ${protocol.version.major} 26 | minor ${protocol.version.minor}`]; 27 | protocol.domains.sort((a, b) => stringCompare(a.domain, b.domain)); 28 | for (let domain of protocol.domains) { 29 | result.push(``); 30 | printDescription(result, domain.description, ``); 31 | result.push(`${domain.experimental ? 'experimental ' : ''}${domain.deprecated ? 'deprecated ' : ''}domain ${domain.domain}`); 32 | 33 | (domain.dependencies || []).forEach(dep => { 34 | result.push(` depends on ${dep}`); 35 | }); 36 | 37 | (domain.types || []).forEach(type => printType(result, type)); 38 | 39 | if (domain.commands) 40 | domain.commands.sort((a, b) => stringCompare(a.name, b.name)); 41 | (domain.commands || []).forEach(command => printCommand(result, command)); 42 | 43 | if (domain.events) 44 | domain.events.sort((a, b) => stringCompare(a.name, b.name)); 45 | (domain.events || []).forEach(event => printEvent(result, event)); 46 | } 47 | result.push(''); 48 | fs.writeFile(name + '_protocol.pdl', result.join('\n'), () => {}); 49 | }); 50 | } 51 | 52 | function printType(result, type) { 53 | result.push(``); 54 | printDescription(result, type.description, ` `); 55 | let typename = type.type; 56 | if (typename === 'array') 57 | typename = `array of ${type.items['$ref'] || type.items.type}`; 58 | result.push(` ${type.experimental ? 'experimental ' : ''}${type.deprecated ? 'deprecated ' : ''}type ${type.id} extends ${typename}`); 59 | if (type.properties && type.properties.length) { 60 | result.push(` properties`); 61 | type.properties.forEach(param => printParam(result, param)); 62 | } 63 | if (type.enum && type.enum.length) { 64 | result.push(` enum`); 65 | type.enum.forEach(literal => printEnumLiteral(result, literal)); 66 | } 67 | } 68 | 69 | function printCommand(result, command) { 70 | result.push(``); 71 | printDescription(result, command.description, ` `); 72 | result.push(` ${command.experimental ? 'experimental ' : ''}${command.deprecated ? 'deprecated ' : ''}command ${command.name}`); 73 | if (command.redirect) { 74 | result.push(` # Use '${command.redirect}.${command.name}' instead`); 75 | result.push(` redirect ${command.redirect}`); 76 | } 77 | if (command.parameters && command.parameters.length) { 78 | result.push(` parameters`); 79 | command.parameters.forEach(param => printParam(result, param)); 80 | } 81 | if (command.returns && command.returns.length) { 82 | result.push(` returns`); 83 | command.returns.forEach(param => printParam(result, param)); 84 | } 85 | } 86 | 87 | function printEvent(result, event) { 88 | result.push(``); 89 | printDescription(result, event.description, ` `); 90 | result.push(` ${event.experimental ? 'experimental ' : ''}${event.deprecated ? 'deprecated ' : ''}event ${event.name}`); 91 | if (event.parameters && event.parameters.length) { 92 | result.push(` parameters`); 93 | event.parameters.forEach(param => printParam(result, param)); 94 | } 95 | } 96 | 97 | function printParam(result, param) { 98 | printDescription(result, param.description, ` `); 99 | let type = param['$ref'] || param.type; 100 | if (type === 'string' && param.enum) 101 | type = 'enum'; 102 | if (param.type === 'array') 103 | type = `array of ${param.items['$ref'] || param.items.type}`; 104 | result.push(` ${param.experimental ? 'experimental ' : ''}${param.deprecated ? 'deprecated ' : ''}${param.optional ? 'optional ' : ''}${type} ${param.name}`); 105 | if (type === 'enum') { 106 | for (let literal of param.enum) 107 | result.push(` ${literal}`); 108 | } 109 | } 110 | 111 | function printEnumLiteral(result, literal) { 112 | result.push(` ${literal}`); 113 | } 114 | 115 | function printDescription(result, description, indent) { 116 | if (!description) 117 | return; 118 | description = description.replace(/<\/?code>/g, '`'); 119 | let line = indent + '#'; 120 | const tokens = description.split(' '); 121 | for (let token of description.split(' ')) { 122 | if (line.length + token.length + 1 > 100) { 123 | result.push(line); 124 | line = indent + '#'; 125 | } 126 | line += ' ' + token; 127 | } 128 | result.push(line); 129 | } 130 | 131 | -------------------------------------------------------------------------------- /docs/applicationcache.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: ApplicationCache 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: ApplicationCache.enable 8 | 9 | Enables application cache domain notifications. 10 | 11 | --- 12 | 13 | 14 | #### command: ApplicationCache.getApplicationCacheForFrame 15 | 16 | Returns relevant application cache data for the document in given frame. 17 | 18 | *parameters* 19 | - `frameId` <[Page.FrameId]> Identifier of the frame containing document whose application cache is retrieved 20 | 21 | *returns* 22 | - `applicationCache` <[ApplicationCache.ApplicationCache]> Relevant application cache data for the document in given frame 23 | 24 | --- 25 | 26 | 27 | #### command: ApplicationCache.getFramesWithManifests 28 | 29 | Returns array of frame identifiers with manifest urls for each frame containing a document 30 | associated with some application cache. 31 | 32 | *returns* 33 | - `frameIds` Array of frame identifiers with manifest urls for each frame containing a document 34 | associated with some application cache 35 | 36 | --- 37 | 38 | 39 | #### command: ApplicationCache.getManifestForFrame 40 | 41 | Returns manifest URL for document in the given frame. 42 | 43 | *parameters* 44 | - `frameId` <[Page.FrameId]> Identifier of the frame containing document whose manifest is retrieved 45 | 46 | *returns* 47 | - `manifestURL` <[string]> Manifest URL for document in the given frame 48 | 49 | --- 50 | 51 | 52 | #### event: ApplicationCache.applicationCacheStatusUpdated 53 | 54 | *parameters* 55 | - `frameId` <[Page.FrameId]> Identifier of the frame containing document whose application cache updated status 56 | - `manifestURL` <[string]> Manifest URL 57 | - `status` <[integer]> Updated application cache status 58 | 59 | --- 60 | 61 | 62 | #### event: ApplicationCache.networkStateUpdated 63 | 64 | *parameters* 65 | - `isNowOnline` <[boolean]> 66 | 67 | --- 68 | 69 | 70 | #### type: ApplicationCache.ApplicationCacheResource 71 | 72 | Detailed application cache resource information. 73 | 74 | *base type* 75 | - **object** 76 | 77 | *properties* 78 | - `url` <[string]> Resource url 79 | - `size` <[integer]> Resource size 80 | - `type` <[string]> Resource type 81 | 82 | *property of type* 83 | - [ApplicationCache.ApplicationCache] 84 | 85 | --- 86 | 87 | 88 | #### type: ApplicationCache.ApplicationCache 89 | 90 | Detailed application cache information. 91 | 92 | *base type* 93 | - **object** 94 | 95 | *properties* 96 | - `manifestURL` <[string]> Manifest URL 97 | - `size` <[number]> Application cache size 98 | - `creationTime` <[number]> Application cache creation time 99 | - `updateTime` <[number]> Application cache update time 100 | - `resources` Application cache resources 101 | 102 | *returned from command* 103 | - [ApplicationCache.getApplicationCacheForFrame] 104 | 105 | --- 106 | 107 | 108 | #### type: ApplicationCache.FrameWithManifest 109 | 110 | Frame identifier - manifest URL pair. 111 | 112 | *base type* 113 | - **object** 114 | 115 | *properties* 116 | - `frameId` <[Page.FrameId]> Frame identifier 117 | - `manifestURL` <[string]> Manifest URL 118 | - `status` <[integer]> Application cache status 119 | 120 | *returned from command* 121 | - [ApplicationCache.getFramesWithManifests] 122 | 123 | [ApplicationCache.ApplicationCache]: applicationcache.md#type-applicationcacheapplicationcache "ApplicationCache.ApplicationCache" 124 | [ApplicationCache.getApplicationCacheForFrame]: applicationcache.md#command-applicationcachegetapplicationcacheforframe "ApplicationCache.getApplicationCacheForFrame" 125 | [ApplicationCache.getFramesWithManifests]: applicationcache.md#command-applicationcachegetframeswithmanifests "ApplicationCache.getFramesWithManifests" 126 | [ApplicationCache.ApplicationCacheResource]: applicationcache.md#type-applicationcacheapplicationcacheresource "ApplicationCache.ApplicationCacheResource" 127 | [Page.FrameId]: page.md#type-pageframeid "Page.FrameId" 128 | [Page.FrameId]: page.md#type-pageframeid "Page.FrameId" 129 | [ApplicationCache.ApplicationCache]: applicationcache.md#type-applicationcacheapplicationcache "ApplicationCache.ApplicationCache" 130 | [ApplicationCache.FrameWithManifest]: applicationcache.md#type-applicationcacheframewithmanifest "ApplicationCache.FrameWithManifest" 131 | [Page.FrameId]: page.md#type-pageframeid "Page.FrameId" 132 | [Page.FrameId]: page.md#type-pageframeid "Page.FrameId" 133 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 134 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 135 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 136 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 137 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 138 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/domstorage.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: DOMStorage 🌱 3 | 4 | Query and modify DOM storage. 5 | 6 | --- 7 | 8 | 9 | #### command: DOMStorage.clear 10 | 11 | *parameters* 12 | - `storageId` <[DOMStorage.StorageId]> 13 | 14 | --- 15 | 16 | 17 | #### command: DOMStorage.disable 18 | 19 | Disables storage tracking, prevents storage events from being sent to the client. 20 | 21 | --- 22 | 23 | 24 | #### command: DOMStorage.enable 25 | 26 | Enables storage tracking, storage events will now be delivered to the client. 27 | 28 | --- 29 | 30 | 31 | #### command: DOMStorage.getDOMStorageItems 32 | 33 | *parameters* 34 | - `storageId` <[DOMStorage.StorageId]> 35 | 36 | *returns* 37 | - `entries` 38 | 39 | --- 40 | 41 | 42 | #### command: DOMStorage.removeDOMStorageItem 43 | 44 | *parameters* 45 | - `storageId` <[DOMStorage.StorageId]> 46 | - `key` <[string]> 47 | 48 | --- 49 | 50 | 51 | #### command: DOMStorage.setDOMStorageItem 52 | 53 | *parameters* 54 | - `storageId` <[DOMStorage.StorageId]> 55 | - `key` <[string]> 56 | - `value` <[string]> 57 | 58 | --- 59 | 60 | 61 | #### event: DOMStorage.domStorageItemAdded 62 | 63 | *parameters* 64 | - `storageId` <[DOMStorage.StorageId]> 65 | - `key` <[string]> 66 | - `newValue` <[string]> 67 | 68 | --- 69 | 70 | 71 | #### event: DOMStorage.domStorageItemRemoved 72 | 73 | *parameters* 74 | - `storageId` <[DOMStorage.StorageId]> 75 | - `key` <[string]> 76 | 77 | --- 78 | 79 | 80 | #### event: DOMStorage.domStorageItemUpdated 81 | 82 | *parameters* 83 | - `storageId` <[DOMStorage.StorageId]> 84 | - `key` <[string]> 85 | - `oldValue` <[string]> 86 | - `newValue` <[string]> 87 | 88 | --- 89 | 90 | 91 | #### event: DOMStorage.domStorageItemsCleared 92 | 93 | *parameters* 94 | - `storageId` <[DOMStorage.StorageId]> 95 | 96 | --- 97 | 98 | 99 | #### type: DOMStorage.StorageId 100 | 101 | DOM Storage identifier. 102 | 103 | *base type* 104 | - **object** 105 | 106 | *properties* 107 | - `securityOrigin` <[string]> Security origin for the storage 108 | - `isLocalStorage` <[boolean]> Whether the storage is local storage (not session storage) 109 | 110 | *accepted by command* 111 | - [DOMStorage.clear] 112 | - [DOMStorage.getDOMStorageItems] 113 | - [DOMStorage.removeDOMStorageItem] 114 | - [DOMStorage.setDOMStorageItem] 115 | 116 | *parameter in event* 117 | - [DOMStorage.domStorageItemAdded] 118 | - [DOMStorage.domStorageItemRemoved] 119 | - [DOMStorage.domStorageItemUpdated] 120 | - [DOMStorage.domStorageItemsCleared] 121 | 122 | --- 123 | 124 | 125 | #### type: DOMStorage.Item 126 | 127 | DOM Storage item. 128 | 129 | *base type* 130 | - **array** 131 | 132 | *returned from command* 133 | - [DOMStorage.getDOMStorageItems] 134 | 135 | [DOMStorage.clear]: domstorage.md#command-domstorageclear "DOMStorage.clear" 136 | [DOMStorage.getDOMStorageItems]: domstorage.md#command-domstoragegetdomstorageitems "DOMStorage.getDOMStorageItems" 137 | [DOMStorage.removeDOMStorageItem]: domstorage.md#command-domstorageremovedomstorageitem "DOMStorage.removeDOMStorageItem" 138 | [DOMStorage.setDOMStorageItem]: domstorage.md#command-domstoragesetdomstorageitem "DOMStorage.setDOMStorageItem" 139 | [DOMStorage.domStorageItemAdded]: domstorage.md#event-domstoragedomstorageitemadded "DOMStorage.domStorageItemAdded" 140 | [DOMStorage.domStorageItemRemoved]: domstorage.md#event-domstoragedomstorageitemremoved "DOMStorage.domStorageItemRemoved" 141 | [DOMStorage.domStorageItemUpdated]: domstorage.md#event-domstoragedomstorageitemupdated "DOMStorage.domStorageItemUpdated" 142 | [DOMStorage.domStorageItemsCleared]: domstorage.md#event-domstoragedomstorageitemscleared "DOMStorage.domStorageItemsCleared" 143 | [DOMStorage.getDOMStorageItems]: domstorage.md#command-domstoragegetdomstorageitems "DOMStorage.getDOMStorageItems" 144 | [DOMStorage.StorageId]: domstorage.md#type-domstoragestorageid "DOMStorage.StorageId" 145 | [DOMStorage.StorageId]: domstorage.md#type-domstoragestorageid "DOMStorage.StorageId" 146 | [DOMStorage.Item]: domstorage.md#type-domstorageitem "DOMStorage.Item" 147 | [DOMStorage.StorageId]: domstorage.md#type-domstoragestorageid "DOMStorage.StorageId" 148 | [DOMStorage.StorageId]: domstorage.md#type-domstoragestorageid "DOMStorage.StorageId" 149 | [DOMStorage.StorageId]: domstorage.md#type-domstoragestorageid "DOMStorage.StorageId" 150 | [DOMStorage.StorageId]: domstorage.md#type-domstoragestorageid "DOMStorage.StorageId" 151 | [DOMStorage.StorageId]: domstorage.md#type-domstoragestorageid "DOMStorage.StorageId" 152 | [DOMStorage.StorageId]: domstorage.md#type-domstoragestorageid "DOMStorage.StorageId" 153 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 154 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 155 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 156 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 157 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 158 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/domdebugger.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: DOMDebugger 3 | 4 | DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript 5 | execution will stop on these operations as if there was a regular breakpoint set. 6 | 7 | --- 8 | 9 | 10 | #### command: DOMDebugger.getEventListeners 11 | 12 | Returns event listeners of the given object. 13 | 14 | *parameters* 15 | - `objectId` <[Runtime.RemoteObjectId]> Identifier of the object to return listeners for 16 | - *optional* `depth` <[integer]> The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the 17 | entire subtree or provide an integer larger than 0 18 | - *optional* `pierce` <[boolean]> Whether or not iframes and shadow roots should be traversed when returning the subtree 19 | (default is false). Reports listeners for all contexts if pierce is enabled 20 | 21 | *returns* 22 | - `listeners` Array of relevant listeners 23 | 24 | --- 25 | 26 | 27 | #### command: DOMDebugger.removeDOMBreakpoint 28 | 29 | Removes DOM breakpoint that was set using `setDOMBreakpoint`. 30 | 31 | *parameters* 32 | - `nodeId` <[DOM.NodeId]> Identifier of the node to remove breakpoint from 33 | - `type` <[DOMDebugger.DOMBreakpointType]> Type of the breakpoint to remove 34 | 35 | --- 36 | 37 | 38 | #### command: DOMDebugger.removeEventListenerBreakpoint 39 | 40 | Removes breakpoint on particular DOM event. 41 | 42 | *parameters* 43 | - `eventName` <[string]> Event name 44 | - *optional* `targetName` <[string]> 🌱 EventTarget interface name 45 | 46 | --- 47 | 48 | 49 | #### command: DOMDebugger.removeInstrumentationBreakpoint 🌱 50 | 51 | Removes breakpoint on particular native event. 52 | 53 | *parameters* 54 | - `eventName` <[string]> Instrumentation name to stop on 55 | 56 | --- 57 | 58 | 59 | #### command: DOMDebugger.removeXHRBreakpoint 60 | 61 | Removes breakpoint from XMLHttpRequest. 62 | 63 | *parameters* 64 | - `url` <[string]> Resource URL substring 65 | 66 | --- 67 | 68 | 69 | #### command: DOMDebugger.setDOMBreakpoint 70 | 71 | Sets breakpoint on particular operation with DOM. 72 | 73 | *parameters* 74 | - `nodeId` <[DOM.NodeId]> Identifier of the node to set breakpoint on 75 | - `type` <[DOMDebugger.DOMBreakpointType]> Type of the operation to stop upon 76 | 77 | --- 78 | 79 | 80 | #### command: DOMDebugger.setEventListenerBreakpoint 81 | 82 | Sets breakpoint on particular DOM event. 83 | 84 | *parameters* 85 | - `eventName` <[string]> DOM Event name to stop on (any DOM event will do) 86 | - *optional* `targetName` <[string]> 🌱 EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any 87 | EventTarget 88 | 89 | --- 90 | 91 | 92 | #### command: DOMDebugger.setInstrumentationBreakpoint 🌱 93 | 94 | Sets breakpoint on particular native event. 95 | 96 | *parameters* 97 | - `eventName` <[string]> Instrumentation name to stop on 98 | 99 | --- 100 | 101 | 102 | #### command: DOMDebugger.setXHRBreakpoint 103 | 104 | Sets breakpoint on XMLHttpRequest. 105 | 106 | *parameters* 107 | - `url` <[string]> Resource URL substring. All XHRs having this substring in the URL will get stopped upon 108 | 109 | --- 110 | 111 | 112 | #### type: DOMDebugger.DOMBreakpointType 113 | 114 | DOM breakpoint type. 115 | 116 | *base type* 117 | - **string** 118 | 119 | *accepted by command* 120 | - [DOMDebugger.removeDOMBreakpoint] 121 | - [DOMDebugger.setDOMBreakpoint] 122 | 123 | --- 124 | 125 | 126 | #### type: DOMDebugger.EventListener 127 | 128 | Object event listener. 129 | 130 | *base type* 131 | - **object** 132 | 133 | *properties* 134 | - `type` <[string]> `EventListener`'s type 135 | - `useCapture` <[boolean]> `EventListener`'s useCapture 136 | - `passive` <[boolean]> `EventListener`'s passive flag 137 | - `once` <[boolean]> `EventListener`'s once flag 138 | - `scriptId` <[Runtime.ScriptId]> Script id of the handler code 139 | - `lineNumber` <[integer]> Line number in the script (0-based) 140 | - `columnNumber` <[integer]> Column number in the script (0-based) 141 | - *optional* `handler` <[Runtime.RemoteObject]> Event handler function value 142 | - *optional* `originalHandler` <[Runtime.RemoteObject]> Event original handler function value 143 | - *optional* `backendNodeId` <[DOM.BackendNodeId]> Node the listener is added to (if any) 144 | 145 | *returned from command* 146 | - [DOMDebugger.getEventListeners] 147 | 148 | [DOMDebugger.removeDOMBreakpoint]: domdebugger.md#command-domdebuggerremovedombreakpoint "DOMDebugger.removeDOMBreakpoint" 149 | [DOMDebugger.setDOMBreakpoint]: domdebugger.md#command-domdebuggersetdombreakpoint "DOMDebugger.setDOMBreakpoint" 150 | [DOMDebugger.getEventListeners]: domdebugger.md#command-domdebuggergeteventlisteners "DOMDebugger.getEventListeners" 151 | [Runtime.ScriptId]: runtime.md#type-runtimescriptid "Runtime.ScriptId" 152 | [Runtime.RemoteObject]: runtime.md#type-runtimeremoteobject "Runtime.RemoteObject" 153 | [DOM.BackendNodeId]: dom.md#type-dombackendnodeid "DOM.BackendNodeId" 154 | [Runtime.RemoteObjectId]: runtime.md#type-runtimeremoteobjectid "Runtime.RemoteObjectId" 155 | [DOMDebugger.EventListener]: domdebugger.md#type-domdebuggereventlistener "DOMDebugger.EventListener" 156 | [DOM.NodeId]: dom.md#type-domnodeid "DOM.NodeId" 157 | [DOMDebugger.DOMBreakpointType]: domdebugger.md#type-domdebuggerdombreakpointtype "DOMDebugger.DOMBreakpointType" 158 | [DOM.NodeId]: dom.md#type-domnodeid "DOM.NodeId" 159 | [DOMDebugger.DOMBreakpointType]: domdebugger.md#type-domdebuggerdombreakpointtype "DOMDebugger.DOMBreakpointType" 160 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 161 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 162 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 163 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 164 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 165 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/cachestorage.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: CacheStorage 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: CacheStorage.deleteCache 8 | 9 | Deletes a cache. 10 | 11 | *parameters* 12 | - `cacheId` <[CacheStorage.CacheId]> Id of cache for deletion 13 | 14 | --- 15 | 16 | 17 | #### command: CacheStorage.deleteEntry 18 | 19 | Deletes a cache entry. 20 | 21 | *parameters* 22 | - `cacheId` <[CacheStorage.CacheId]> Id of cache where the entry will be deleted 23 | - `request` <[string]> URL spec of the request 24 | 25 | --- 26 | 27 | 28 | #### command: CacheStorage.requestCacheNames 29 | 30 | Requests cache names. 31 | 32 | *parameters* 33 | - `securityOrigin` <[string]> Security origin 34 | 35 | *returns* 36 | - `caches` Caches for the security origin 37 | 38 | --- 39 | 40 | 41 | #### command: CacheStorage.requestCachedResponse 42 | 43 | Fetches cache entry. 44 | 45 | *parameters* 46 | - `cacheId` <[CacheStorage.CacheId]> Id of cache that contains the enty 47 | - `requestURL` <[string]> URL spec of the request 48 | 49 | *returns* 50 | - `response` <[CacheStorage.CachedResponse]> Response read from the cache 51 | 52 | --- 53 | 54 | 55 | #### command: CacheStorage.requestEntries 56 | 57 | Requests data from cache. 58 | 59 | *parameters* 60 | - `cacheId` <[CacheStorage.CacheId]> ID of cache to get entries from 61 | - `skipCount` <[integer]> Number of records to skip 62 | - `pageSize` <[integer]> Number of records to fetch 63 | 64 | *returns* 65 | - `cacheDataEntries` Array of object store data entries 66 | - `hasMore` <[boolean]> If true, there are more entries to fetch in the given range 67 | 68 | --- 69 | 70 | 71 | #### type: CacheStorage.CacheId 72 | 73 | Unique identifier of the Cache object. 74 | 75 | *base type* 76 | - **string** 77 | 78 | *property of type* 79 | - [CacheStorage.Cache] 80 | 81 | *accepted by command* 82 | - [CacheStorage.deleteCache] 83 | - [CacheStorage.deleteEntry] 84 | - [CacheStorage.requestCachedResponse] 85 | - [CacheStorage.requestEntries] 86 | 87 | --- 88 | 89 | 90 | #### type: CacheStorage.DataEntry 91 | 92 | Data entry. 93 | 94 | *base type* 95 | - **object** 96 | 97 | *properties* 98 | - `requestURL` <[string]> Request URL 99 | - `requestMethod` <[string]> Request method 100 | - `requestHeaders` Request headers 101 | - `responseTime` <[number]> Number of seconds since epoch 102 | - `responseStatus` <[integer]> HTTP response status code 103 | - `responseStatusText` <[string]> HTTP response status text 104 | - `responseHeaders` Response headers 105 | 106 | *returned from command* 107 | - [CacheStorage.requestEntries] 108 | 109 | --- 110 | 111 | 112 | #### type: CacheStorage.Cache 113 | 114 | Cache identifier. 115 | 116 | *base type* 117 | - **object** 118 | 119 | *properties* 120 | - `cacheId` <[CacheStorage.CacheId]> An opaque unique id of the cache 121 | - `securityOrigin` <[string]> Security origin of the cache 122 | - `cacheName` <[string]> The name of the cache 123 | 124 | *returned from command* 125 | - [CacheStorage.requestCacheNames] 126 | 127 | --- 128 | 129 | 130 | #### type: CacheStorage.Header 131 | 132 | *base type* 133 | - **object** 134 | 135 | *properties* 136 | - `name` <[string]> 137 | - `value` <[string]> 138 | 139 | *property of type* 140 | - [CacheStorage.DataEntry] 141 | 142 | --- 143 | 144 | 145 | #### type: CacheStorage.CachedResponse 146 | 147 | Cached response 148 | 149 | *base type* 150 | - **object** 151 | 152 | *properties* 153 | - `body` <[string]> Entry content, base64-encoded 154 | 155 | *returned from command* 156 | - [CacheStorage.requestCachedResponse] 157 | 158 | [CacheStorage.Cache]: cachestorage.md#type-cachestoragecache "CacheStorage.Cache" 159 | [CacheStorage.deleteCache]: cachestorage.md#command-cachestoragedeletecache "CacheStorage.deleteCache" 160 | [CacheStorage.deleteEntry]: cachestorage.md#command-cachestoragedeleteentry "CacheStorage.deleteEntry" 161 | [CacheStorage.requestCachedResponse]: cachestorage.md#command-cachestoragerequestcachedresponse "CacheStorage.requestCachedResponse" 162 | [CacheStorage.requestEntries]: cachestorage.md#command-cachestoragerequestentries "CacheStorage.requestEntries" 163 | [CacheStorage.requestEntries]: cachestorage.md#command-cachestoragerequestentries "CacheStorage.requestEntries" 164 | [CacheStorage.requestCacheNames]: cachestorage.md#command-cachestoragerequestcachenames "CacheStorage.requestCacheNames" 165 | [CacheStorage.DataEntry]: cachestorage.md#type-cachestoragedataentry "CacheStorage.DataEntry" 166 | [CacheStorage.requestCachedResponse]: cachestorage.md#command-cachestoragerequestcachedresponse "CacheStorage.requestCachedResponse" 167 | [CacheStorage.Header]: cachestorage.md#type-cachestorageheader "CacheStorage.Header" 168 | [CacheStorage.CacheId]: cachestorage.md#type-cachestoragecacheid "CacheStorage.CacheId" 169 | [CacheStorage.CacheId]: cachestorage.md#type-cachestoragecacheid "CacheStorage.CacheId" 170 | [CacheStorage.CacheId]: cachestorage.md#type-cachestoragecacheid "CacheStorage.CacheId" 171 | [CacheStorage.Cache]: cachestorage.md#type-cachestoragecache "CacheStorage.Cache" 172 | [CacheStorage.CacheId]: cachestorage.md#type-cachestoragecacheid "CacheStorage.CacheId" 173 | [CacheStorage.CachedResponse]: cachestorage.md#type-cachestoragecachedresponse "CacheStorage.CachedResponse" 174 | [CacheStorage.CacheId]: cachestorage.md#type-cachestoragecacheid "CacheStorage.CacheId" 175 | [CacheStorage.DataEntry]: cachestorage.md#type-cachestoragedataentry "CacheStorage.DataEntry" 176 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 177 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 178 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 179 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 180 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 181 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /parse.py: -------------------------------------------------------------------------------- 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 | 5 | import collections 6 | import json 7 | import os.path 8 | import re 9 | import sys 10 | 11 | file_name = None 12 | description = '' 13 | 14 | primitiveTypes = ['integer', 'number', 'boolean', 'string', 'object', 'any', 'array'] 15 | 16 | 17 | def assignType(item, type, isArray=False): 18 | if isArray: 19 | item['type'] = 'array' 20 | item['items'] = collections.OrderedDict() 21 | assignType(item['items'], type) 22 | return 23 | 24 | if type == 'enum': 25 | type = 'string' 26 | if type in primitiveTypes: 27 | item['type'] = type 28 | else: 29 | item['$ref'] = type 30 | 31 | 32 | def createItem(d, experimental, deprecated, name=None): 33 | result = collections.OrderedDict(d) 34 | if name: 35 | result['name'] = name 36 | global description 37 | if description: 38 | result['description'] = description.strip() 39 | if experimental: 40 | result['experimental'] = True 41 | if deprecated: 42 | result['deprecated'] = True 43 | return result 44 | 45 | 46 | def parse(data): 47 | protocol = collections.OrderedDict() 48 | protocol['version'] = collections.OrderedDict() 49 | protocol['domains'] = [] 50 | domain = None 51 | item = None 52 | subitems = None 53 | nukeDescription = False 54 | global description 55 | lines = data.split('\n') 56 | for i in range(0, len(lines)): 57 | if nukeDescription: 58 | description = '' 59 | nukeDescription = False 60 | line = lines[i] 61 | trimLine = line.strip() 62 | 63 | if trimLine.startswith('#'): 64 | description += trimLine[1:] 65 | continue 66 | else: 67 | nukeDescription = True 68 | 69 | if len(trimLine) == 0: 70 | continue 71 | 72 | match = re.compile('^(experimental )?(deprecated )?domain (.*)').match(line) 73 | if match: 74 | domain = createItem({'domain' : match.group(3)}, match.group(1), match.group(2)) 75 | protocol['domains'].append(domain) 76 | continue 77 | 78 | match = re.compile('^ depends on ([^\s]+)').match(line) 79 | if match: 80 | if 'dependencies' not in domain: 81 | domain['dependencies'] = [] 82 | domain['dependencies'].append(match.group(1)) 83 | continue 84 | 85 | match = re.compile('^ (experimental )?(deprecated )?type (.*) extends (array of )?([^\s]+)').match(line) 86 | if match: 87 | if 'types' not in domain: 88 | domain['types'] = [] 89 | item = createItem({'id': match.group(3)}, match.group(1), match.group(2)) 90 | assignType(item, match.group(5), match.group(4)) 91 | domain['types'].append(item) 92 | continue 93 | 94 | match = re.compile('^ (experimental )?(deprecated )?(command|event) (.*)').match(line) 95 | if match: 96 | list = [] 97 | if match.group(3) == 'command': 98 | if 'commands' in domain: 99 | list = domain['commands'] 100 | else: 101 | list = domain['commands'] = [] 102 | else: 103 | if 'events' in domain: 104 | list = domain['events'] 105 | else: 106 | list = domain['events'] = [] 107 | 108 | item = createItem({}, match.group(1), match.group(2), match.group(4)) 109 | list.append(item) 110 | continue 111 | 112 | match = re.compile('^ (experimental )?(deprecated )?(optional )?(array of )?([^\s]+) ([^\s]+)').match(line) 113 | if match: 114 | param = createItem({}, match.group(1), match.group(2), match.group(6)) 115 | if match.group(3): 116 | param['optional'] = True 117 | assignType(param, match.group(5), match.group(4)) 118 | if match.group(5) == 'enum': 119 | enumliterals = param['enum'] = [] 120 | subitems.append(param) 121 | continue 122 | 123 | match = re.compile('^ (parameters|returns|properties)').match(line) 124 | if match: 125 | subitems = item[match.group(1)] = [] 126 | continue 127 | 128 | match = re.compile('^ enum').match(line) 129 | if match: 130 | enumliterals = item['enum'] = [] 131 | continue 132 | 133 | match = re.compile('^version').match(line) 134 | if match: 135 | continue 136 | 137 | match = re.compile('^ major (\d+)').match(line) 138 | if match: 139 | protocol['version']['major'] = match.group(1) 140 | continue 141 | 142 | match = re.compile('^ minor (\d+)').match(line) 143 | if match: 144 | protocol['version']['minor'] = match.group(1) 145 | continue 146 | 147 | match = re.compile('^ redirect ([^\s]+)').match(line) 148 | if match: 149 | item['redirect'] = match.group(1) 150 | continue 151 | 152 | match = re.compile('^ ( )?[^\s]+$').match(line) 153 | if match: 154 | # enum literal 155 | enumliterals.append(trimLine) 156 | continue 157 | 158 | print 'Error in %s:%s, illegal token: \t%s' % (file_name, i, line) 159 | sys.exit(1) 160 | return protocol 161 | 162 | def main(argv): 163 | if len(argv) < 2: 164 | sys.stderr.write("Usage: %s stamp \n" % sys.argv[0]) 165 | return 1 166 | global file_name 167 | file_name = os.path.normpath(argv[1]) 168 | input_file = open(file_name, "r") 169 | pdl_string = input_file.read() 170 | protocol = parse(pdl_string) 171 | output_file = open(argv[1].replace('.pdl', '.json'), 'wb') 172 | json.dump(protocol, output_file, indent=4, separators=(',', ': ')) 173 | output_file.close() 174 | with open(os.path.normpath(argv[0]), 'a') as _: 175 | pass 176 | 177 | 178 | if __name__ == '__main__': 179 | sys.exit(main(sys.argv[1:])) 180 | -------------------------------------------------------------------------------- /docs/serviceworker.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: ServiceWorker 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: ServiceWorker.deliverPushMessage 8 | 9 | *parameters* 10 | - `origin` <[string]> 11 | - `registrationId` <[string]> 12 | - `data` <[string]> 13 | 14 | --- 15 | 16 | 17 | #### command: ServiceWorker.disable 18 | 19 | --- 20 | 21 | 22 | #### command: ServiceWorker.dispatchSyncEvent 23 | 24 | *parameters* 25 | - `origin` <[string]> 26 | - `registrationId` <[string]> 27 | - `tag` <[string]> 28 | - `lastChance` <[boolean]> 29 | 30 | --- 31 | 32 | 33 | #### command: ServiceWorker.enable 34 | 35 | --- 36 | 37 | 38 | #### command: ServiceWorker.inspectWorker 39 | 40 | *parameters* 41 | - `versionId` <[string]> 42 | 43 | --- 44 | 45 | 46 | #### command: ServiceWorker.setForceUpdateOnPageLoad 47 | 48 | *parameters* 49 | - `forceUpdateOnPageLoad` <[boolean]> 50 | 51 | --- 52 | 53 | 54 | #### command: ServiceWorker.skipWaiting 55 | 56 | *parameters* 57 | - `scopeURL` <[string]> 58 | 59 | --- 60 | 61 | 62 | #### command: ServiceWorker.startWorker 63 | 64 | *parameters* 65 | - `scopeURL` <[string]> 66 | 67 | --- 68 | 69 | 70 | #### command: ServiceWorker.stopAllWorkers 71 | 72 | --- 73 | 74 | 75 | #### command: ServiceWorker.stopWorker 76 | 77 | *parameters* 78 | - `versionId` <[string]> 79 | 80 | --- 81 | 82 | 83 | #### command: ServiceWorker.unregister 84 | 85 | *parameters* 86 | - `scopeURL` <[string]> 87 | 88 | --- 89 | 90 | 91 | #### command: ServiceWorker.updateRegistration 92 | 93 | *parameters* 94 | - `scopeURL` <[string]> 95 | 96 | --- 97 | 98 | 99 | #### event: ServiceWorker.workerErrorReported 100 | 101 | *parameters* 102 | - `errorMessage` <[ServiceWorker.ServiceWorkerErrorMessage]> 103 | 104 | --- 105 | 106 | 107 | #### event: ServiceWorker.workerRegistrationUpdated 108 | 109 | *parameters* 110 | - `registrations` 111 | 112 | --- 113 | 114 | 115 | #### event: ServiceWorker.workerVersionUpdated 116 | 117 | *parameters* 118 | - `versions` 119 | 120 | --- 121 | 122 | 123 | #### type: ServiceWorker.ServiceWorkerRegistration 124 | 125 | ServiceWorker registration. 126 | 127 | *base type* 128 | - **object** 129 | 130 | *properties* 131 | - `registrationId` <[string]> 132 | - `scopeURL` <[string]> 133 | - `isDeleted` <[boolean]> 134 | 135 | *parameter in event* 136 | - [ServiceWorker.workerRegistrationUpdated] 137 | 138 | --- 139 | 140 | 141 | #### type: ServiceWorker.ServiceWorkerVersionRunningStatus 142 | 143 | *base type* 144 | - **string** 145 | 146 | *property of type* 147 | - [ServiceWorker.ServiceWorkerVersion] 148 | 149 | --- 150 | 151 | 152 | #### type: ServiceWorker.ServiceWorkerVersionStatus 153 | 154 | *base type* 155 | - **string** 156 | 157 | *property of type* 158 | - [ServiceWorker.ServiceWorkerVersion] 159 | 160 | --- 161 | 162 | 163 | #### type: ServiceWorker.ServiceWorkerVersion 164 | 165 | ServiceWorker version. 166 | 167 | *base type* 168 | - **object** 169 | 170 | *properties* 171 | - `versionId` <[string]> 172 | - `registrationId` <[string]> 173 | - `scriptURL` <[string]> 174 | - `runningStatus` <[ServiceWorker.ServiceWorkerVersionRunningStatus]> 175 | - `status` <[ServiceWorker.ServiceWorkerVersionStatus]> 176 | - *optional* `scriptLastModified` <[number]> The Last-Modified header value of the main script 177 | - *optional* `scriptResponseTime` <[number]> The time at which the response headers of the main script were received from the server. 178 | For cached script it is the last time the cache entry was validated 179 | - *optional* `controlledClients` 180 | - *optional* `targetId` <[Target.TargetID]> 181 | 182 | *parameter in event* 183 | - [ServiceWorker.workerVersionUpdated] 184 | 185 | --- 186 | 187 | 188 | #### type: ServiceWorker.ServiceWorkerErrorMessage 189 | 190 | ServiceWorker error message. 191 | 192 | *base type* 193 | - **object** 194 | 195 | *properties* 196 | - `errorMessage` <[string]> 197 | - `registrationId` <[string]> 198 | - `versionId` <[string]> 199 | - `sourceURL` <[string]> 200 | - `lineNumber` <[integer]> 201 | - `columnNumber` <[integer]> 202 | 203 | *parameter in event* 204 | - [ServiceWorker.workerErrorReported] 205 | 206 | [ServiceWorker.workerRegistrationUpdated]: serviceworker.md#event-serviceworkerworkerregistrationupdated "ServiceWorker.workerRegistrationUpdated" 207 | [ServiceWorker.ServiceWorkerVersion]: serviceworker.md#type-serviceworkerserviceworkerversion "ServiceWorker.ServiceWorkerVersion" 208 | [ServiceWorker.ServiceWorkerVersion]: serviceworker.md#type-serviceworkerserviceworkerversion "ServiceWorker.ServiceWorkerVersion" 209 | [ServiceWorker.workerVersionUpdated]: serviceworker.md#event-serviceworkerworkerversionupdated "ServiceWorker.workerVersionUpdated" 210 | [ServiceWorker.workerErrorReported]: serviceworker.md#event-serviceworkerworkererrorreported "ServiceWorker.workerErrorReported" 211 | [ServiceWorker.ServiceWorkerVersionRunningStatus]: serviceworker.md#type-serviceworkerserviceworkerversionrunningstatus "ServiceWorker.ServiceWorkerVersionRunningStatus" 212 | [ServiceWorker.ServiceWorkerVersionStatus]: serviceworker.md#type-serviceworkerserviceworkerversionstatus "ServiceWorker.ServiceWorkerVersionStatus" 213 | [Target.TargetID]: target.md#type-targettargetid "Target.TargetID" 214 | [ServiceWorker.ServiceWorkerErrorMessage]: serviceworker.md#type-serviceworkerserviceworkererrormessage "ServiceWorker.ServiceWorkerErrorMessage" 215 | [ServiceWorker.ServiceWorkerRegistration]: serviceworker.md#type-serviceworkerserviceworkerregistration "ServiceWorker.ServiceWorkerRegistration" 216 | [ServiceWorker.ServiceWorkerVersion]: serviceworker.md#type-serviceworkerserviceworkerversion "ServiceWorker.ServiceWorkerVersion" 217 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 218 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 219 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 220 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 221 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 222 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/animation.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Animation 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: Animation.disable 8 | 9 | Disables animation domain notifications. 10 | 11 | --- 12 | 13 | 14 | #### command: Animation.enable 15 | 16 | Enables animation domain notifications. 17 | 18 | --- 19 | 20 | 21 | #### command: Animation.getCurrentTime 22 | 23 | Returns the current time of the an animation. 24 | 25 | *parameters* 26 | - `id` <[string]> Id of animation 27 | 28 | *returns* 29 | - `currentTime` <[number]> Current time of the page 30 | 31 | --- 32 | 33 | 34 | #### command: Animation.getPlaybackRate 35 | 36 | Gets the playback rate of the document timeline. 37 | 38 | *returns* 39 | - `playbackRate` <[number]> Playback rate for animations on page 40 | 41 | --- 42 | 43 | 44 | #### command: Animation.releaseAnimations 45 | 46 | Releases a set of animations to no longer be manipulated. 47 | 48 | *parameters* 49 | - `animations` List of animation ids to seek 50 | 51 | --- 52 | 53 | 54 | #### command: Animation.resolveAnimation 55 | 56 | Gets the remote object of the Animation. 57 | 58 | *parameters* 59 | - `animationId` <[string]> Animation id 60 | 61 | *returns* 62 | - `remoteObject` <[Runtime.RemoteObject]> Corresponding remote object 63 | 64 | --- 65 | 66 | 67 | #### command: Animation.seekAnimations 68 | 69 | Seek a set of animations to a particular time within each animation. 70 | 71 | *parameters* 72 | - `animations` List of animation ids to seek 73 | - `currentTime` <[number]> Set the current time of each animation 74 | 75 | --- 76 | 77 | 78 | #### command: Animation.setPaused 79 | 80 | Sets the paused state of a set of animations. 81 | 82 | *parameters* 83 | - `animations` Animations to set the pause state of 84 | - `paused` <[boolean]> Paused state to set to 85 | 86 | --- 87 | 88 | 89 | #### command: Animation.setPlaybackRate 90 | 91 | Sets the playback rate of the document timeline. 92 | 93 | *parameters* 94 | - `playbackRate` <[number]> Playback rate for animations on page 95 | 96 | --- 97 | 98 | 99 | #### command: Animation.setTiming 100 | 101 | Sets the timing of an animation node. 102 | 103 | *parameters* 104 | - `animationId` <[string]> Animation id 105 | - `duration` <[number]> Duration of the animation 106 | - `delay` <[number]> Delay of the animation 107 | 108 | --- 109 | 110 | 111 | #### event: Animation.animationCanceled 112 | 113 | Event for when an animation has been cancelled. 114 | 115 | *parameters* 116 | - `id` <[string]> Id of the animation that was cancelled 117 | 118 | --- 119 | 120 | 121 | #### event: Animation.animationCreated 122 | 123 | Event for each animation that has been created. 124 | 125 | *parameters* 126 | - `id` <[string]> Id of the animation that was created 127 | 128 | --- 129 | 130 | 131 | #### event: Animation.animationStarted 132 | 133 | Event for animation that has been started. 134 | 135 | *parameters* 136 | - `animation` <[Animation.Animation]> Animation that was started 137 | 138 | --- 139 | 140 | 141 | #### type: Animation.Animation 142 | 143 | Animation instance. 144 | 145 | *base type* 146 | - **object** 147 | 148 | *properties* 149 | - `id` <[string]> `Animation`'s id 150 | - `name` <[string]> `Animation`'s name 151 | - `pausedState` <[boolean]> `Animation`'s internal paused state 152 | - `playState` <[string]> `Animation`'s play state 153 | - `playbackRate` <[number]> `Animation`'s playback rate 154 | - `startTime` <[number]> `Animation`'s start time 155 | - `currentTime` <[number]> `Animation`'s current time 156 | - `type` <[string]> Animation type of `Animation` 157 | - *optional* `source` <[Animation.AnimationEffect]> `Animation`'s source animation node 158 | - *optional* `cssId` <[string]> A unique ID for `Animation` representing the sources that triggered this CSS 159 | animation/transition 160 | 161 | *parameter in event* 162 | - [Animation.animationStarted] 163 | 164 | --- 165 | 166 | 167 | #### type: Animation.AnimationEffect 168 | 169 | AnimationEffect instance 170 | 171 | *base type* 172 | - **object** 173 | 174 | *properties* 175 | - `delay` <[number]> `AnimationEffect`'s delay 176 | - `endDelay` <[number]> `AnimationEffect`'s end delay 177 | - `iterationStart` <[number]> `AnimationEffect`'s iteration start 178 | - `iterations` <[number]> `AnimationEffect`'s iterations 179 | - `duration` <[number]> `AnimationEffect`'s iteration duration 180 | - `direction` <[string]> `AnimationEffect`'s playback direction 181 | - `fill` <[string]> `AnimationEffect`'s fill mode 182 | - *optional* `backendNodeId` <[DOM.BackendNodeId]> `AnimationEffect`'s target node 183 | - *optional* `keyframesRule` <[Animation.KeyframesRule]> `AnimationEffect`'s keyframes 184 | - `easing` <[string]> `AnimationEffect`'s timing function 185 | 186 | *property of type* 187 | - [Animation.Animation] 188 | 189 | --- 190 | 191 | 192 | #### type: Animation.KeyframesRule 193 | 194 | Keyframes Rule 195 | 196 | *base type* 197 | - **object** 198 | 199 | *properties* 200 | - *optional* `name` <[string]> CSS keyframed animation's name 201 | - `keyframes` List of animation keyframes 202 | 203 | *property of type* 204 | - [Animation.AnimationEffect] 205 | 206 | --- 207 | 208 | 209 | #### type: Animation.KeyframeStyle 210 | 211 | Keyframe Style 212 | 213 | *base type* 214 | - **object** 215 | 216 | *properties* 217 | - `offset` <[string]> Keyframe's time offset 218 | - `easing` <[string]> `AnimationEffect`'s timing function 219 | 220 | *property of type* 221 | - [Animation.KeyframesRule] 222 | 223 | [Animation.animationStarted]: animation.md#event-animationanimationstarted "Animation.animationStarted" 224 | [Animation.Animation]: animation.md#type-animationanimation "Animation.Animation" 225 | [Animation.AnimationEffect]: animation.md#type-animationanimationeffect "Animation.AnimationEffect" 226 | [Animation.KeyframesRule]: animation.md#type-animationkeyframesrule "Animation.KeyframesRule" 227 | [Animation.AnimationEffect]: animation.md#type-animationanimationeffect "Animation.AnimationEffect" 228 | [DOM.BackendNodeId]: dom.md#type-dombackendnodeid "DOM.BackendNodeId" 229 | [Animation.KeyframesRule]: animation.md#type-animationkeyframesrule "Animation.KeyframesRule" 230 | [Animation.KeyframeStyle]: animation.md#type-animationkeyframestyle "Animation.KeyframeStyle" 231 | [Runtime.RemoteObject]: runtime.md#type-runtimeremoteobject "Runtime.RemoteObject" 232 | [Animation.Animation]: animation.md#type-animationanimation "Animation.Animation" 233 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 234 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 235 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 236 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 237 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 238 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/indexeddb.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: IndexedDB 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: IndexedDB.clearObjectStore 8 | 9 | Clears all entries from an object store. 10 | 11 | *parameters* 12 | - `securityOrigin` <[string]> Security origin 13 | - `databaseName` <[string]> Database name 14 | - `objectStoreName` <[string]> Object store name 15 | 16 | --- 17 | 18 | 19 | #### command: IndexedDB.deleteDatabase 20 | 21 | Deletes a database. 22 | 23 | *parameters* 24 | - `securityOrigin` <[string]> Security origin 25 | - `databaseName` <[string]> Database name 26 | 27 | --- 28 | 29 | 30 | #### command: IndexedDB.disable 31 | 32 | Disables events from backend. 33 | 34 | --- 35 | 36 | 37 | #### command: IndexedDB.enable 38 | 39 | Enables events from backend. 40 | 41 | --- 42 | 43 | 44 | #### command: IndexedDB.requestData 45 | 46 | Requests data from object store or index. 47 | 48 | *parameters* 49 | - `securityOrigin` <[string]> Security origin 50 | - `databaseName` <[string]> Database name 51 | - `objectStoreName` <[string]> Object store name 52 | - `indexName` <[string]> Index name, empty string for object store data requests 53 | - `skipCount` <[integer]> Number of records to skip 54 | - `pageSize` <[integer]> Number of records to fetch 55 | - *optional* `keyRange` <[IndexedDB.KeyRange]> Key range 56 | 57 | *returns* 58 | - `objectStoreDataEntries` Array of object store data entries 59 | - `hasMore` <[boolean]> If true, there are more entries to fetch in the given range 60 | 61 | --- 62 | 63 | 64 | #### command: IndexedDB.requestDatabase 65 | 66 | Requests database with given name in given frame. 67 | 68 | *parameters* 69 | - `securityOrigin` <[string]> Security origin 70 | - `databaseName` <[string]> Database name 71 | 72 | *returns* 73 | - `databaseWithObjectStores` <[IndexedDB.DatabaseWithObjectStores]> Database with an array of object stores 74 | 75 | --- 76 | 77 | 78 | #### command: IndexedDB.requestDatabaseNames 79 | 80 | Requests database names for given security origin. 81 | 82 | *parameters* 83 | - `securityOrigin` <[string]> Security origin 84 | 85 | *returns* 86 | - `databaseNames` Database names for origin 87 | 88 | --- 89 | 90 | 91 | #### type: IndexedDB.DatabaseWithObjectStores 92 | 93 | Database with an array of object stores. 94 | 95 | *base type* 96 | - **object** 97 | 98 | *properties* 99 | - `name` <[string]> Database name 100 | - `version` <[integer]> Database version 101 | - `objectStores` Object stores in this database 102 | 103 | *returned from command* 104 | - [IndexedDB.requestDatabase] 105 | 106 | --- 107 | 108 | 109 | #### type: IndexedDB.ObjectStore 110 | 111 | Object store. 112 | 113 | *base type* 114 | - **object** 115 | 116 | *properties* 117 | - `name` <[string]> Object store name 118 | - `keyPath` <[IndexedDB.KeyPath]> Object store key path 119 | - `autoIncrement` <[boolean]> If true, object store has auto increment flag set 120 | - `indexes` Indexes in this object store 121 | 122 | *property of type* 123 | - [IndexedDB.DatabaseWithObjectStores] 124 | 125 | --- 126 | 127 | 128 | #### type: IndexedDB.ObjectStoreIndex 129 | 130 | Object store index. 131 | 132 | *base type* 133 | - **object** 134 | 135 | *properties* 136 | - `name` <[string]> Index name 137 | - `keyPath` <[IndexedDB.KeyPath]> Index key path 138 | - `unique` <[boolean]> If true, index is unique 139 | - `multiEntry` <[boolean]> If true, index allows multiple entries for a key 140 | 141 | *property of type* 142 | - [IndexedDB.ObjectStore] 143 | 144 | --- 145 | 146 | 147 | #### type: IndexedDB.Key 148 | 149 | Key. 150 | 151 | *base type* 152 | - **object** 153 | 154 | *properties* 155 | - `type` <[string]> Key type 156 | - *optional* `number` <[number]> Number value 157 | - *optional* `string` <[string]> String value 158 | - *optional* `date` <[number]> Date value 159 | - *optional* `array` Array value 160 | 161 | *property of type* 162 | - [IndexedDB.Key] 163 | - [IndexedDB.KeyRange] 164 | 165 | --- 166 | 167 | 168 | #### type: IndexedDB.KeyRange 169 | 170 | Key range. 171 | 172 | *base type* 173 | - **object** 174 | 175 | *properties* 176 | - *optional* `lower` <[IndexedDB.Key]> Lower bound 177 | - *optional* `upper` <[IndexedDB.Key]> Upper bound 178 | - `lowerOpen` <[boolean]> If true lower bound is open 179 | - `upperOpen` <[boolean]> If true upper bound is open 180 | 181 | *accepted by command* 182 | - [IndexedDB.requestData] 183 | 184 | --- 185 | 186 | 187 | #### type: IndexedDB.DataEntry 188 | 189 | Data entry. 190 | 191 | *base type* 192 | - **object** 193 | 194 | *properties* 195 | - `key` <[Runtime.RemoteObject]> Key object 196 | - `primaryKey` <[Runtime.RemoteObject]> Primary key object 197 | - `value` <[Runtime.RemoteObject]> Value object 198 | 199 | *returned from command* 200 | - [IndexedDB.requestData] 201 | 202 | --- 203 | 204 | 205 | #### type: IndexedDB.KeyPath 206 | 207 | Key path. 208 | 209 | *base type* 210 | - **object** 211 | 212 | *properties* 213 | - `type` <[string]> Key path type 214 | - *optional* `string` <[string]> String value 215 | - *optional* `array` Array value 216 | 217 | *property of type* 218 | - [IndexedDB.ObjectStore] 219 | - [IndexedDB.ObjectStoreIndex] 220 | 221 | [IndexedDB.requestDatabase]: indexeddb.md#command-indexeddbrequestdatabase "IndexedDB.requestDatabase" 222 | [IndexedDB.DatabaseWithObjectStores]: indexeddb.md#type-indexeddbdatabasewithobjectstores "IndexedDB.DatabaseWithObjectStores" 223 | [IndexedDB.ObjectStore]: indexeddb.md#type-indexeddbobjectstore "IndexedDB.ObjectStore" 224 | [IndexedDB.Key]: indexeddb.md#type-indexeddbkey "IndexedDB.Key" 225 | [IndexedDB.KeyRange]: indexeddb.md#type-indexeddbkeyrange "IndexedDB.KeyRange" 226 | [IndexedDB.requestData]: indexeddb.md#command-indexeddbrequestdata "IndexedDB.requestData" 227 | [IndexedDB.requestData]: indexeddb.md#command-indexeddbrequestdata "IndexedDB.requestData" 228 | [IndexedDB.ObjectStore]: indexeddb.md#type-indexeddbobjectstore "IndexedDB.ObjectStore" 229 | [IndexedDB.ObjectStoreIndex]: indexeddb.md#type-indexeddbobjectstoreindex "IndexedDB.ObjectStoreIndex" 230 | [IndexedDB.ObjectStore]: indexeddb.md#type-indexeddbobjectstore "IndexedDB.ObjectStore" 231 | [IndexedDB.KeyPath]: indexeddb.md#type-indexeddbkeypath "IndexedDB.KeyPath" 232 | [IndexedDB.ObjectStoreIndex]: indexeddb.md#type-indexeddbobjectstoreindex "IndexedDB.ObjectStoreIndex" 233 | [IndexedDB.KeyPath]: indexeddb.md#type-indexeddbkeypath "IndexedDB.KeyPath" 234 | [IndexedDB.Key]: indexeddb.md#type-indexeddbkey "IndexedDB.Key" 235 | [IndexedDB.Key]: indexeddb.md#type-indexeddbkey "IndexedDB.Key" 236 | [Runtime.RemoteObject]: runtime.md#type-runtimeremoteobject "Runtime.RemoteObject" 237 | [IndexedDB.KeyRange]: indexeddb.md#type-indexeddbkeyrange "IndexedDB.KeyRange" 238 | [IndexedDB.DataEntry]: indexeddb.md#type-indexeddbdataentry "IndexedDB.DataEntry" 239 | [IndexedDB.DatabaseWithObjectStores]: indexeddb.md#type-indexeddbdatabasewithobjectstores "IndexedDB.DatabaseWithObjectStores" 240 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 241 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 242 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 243 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 244 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 245 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/security.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Security 3 | 4 | Security 5 | 6 | --- 7 | 8 | 9 | #### command: Security.disable 10 | 11 | Disables tracking security state changes. 12 | 13 | --- 14 | 15 | 16 | #### command: Security.enable 17 | 18 | Enables tracking security state changes. 19 | 20 | --- 21 | 22 | 23 | #### command: Security.handleCertificateError 24 | 25 | Handles a certificate error that fired a certificateError event. 26 | 27 | *parameters* 28 | - `eventId` <[integer]> The ID of the event 29 | - `action` <[Security.CertificateErrorAction]> The action to take on the certificate error 30 | 31 | --- 32 | 33 | 34 | #### command: Security.setOverrideCertificateErrors 35 | 36 | Enable/disable overriding certificate errors. If enabled, all certificate error events need to 37 | be handled by the DevTools client and should be answered with handleCertificateError commands. 38 | 39 | *parameters* 40 | - `override` <[boolean]> If true, certificate errors will be overridden 41 | 42 | --- 43 | 44 | 45 | #### event: Security.certificateError 46 | 47 | There is a certificate error. If overriding certificate errors is enabled, then it should be 48 | handled with the handleCertificateError command. Note: this event does not fire if the 49 | certificate error has been allowed internally. 50 | 51 | *parameters* 52 | - `eventId` <[integer]> The ID of the event 53 | - `errorType` <[string]> The type of the error 54 | - `requestURL` <[string]> The url that was requested 55 | 56 | --- 57 | 58 | 59 | #### event: Security.securityStateChanged 60 | 61 | The security state of the page changed. 62 | 63 | *parameters* 64 | - `securityState` <[Security.SecurityState]> Security state 65 | - `schemeIsCryptographic` <[boolean]> True if the page was loaded over cryptographic transport such as HTTPS 66 | - `explanations` List of explanations for the security state. If the overall security state is `insecure` or 67 | `warning`, at least one corresponding explanation should be included 68 | - `insecureContentStatus` <[Security.InsecureContentStatus]> Information about insecure content on the page 69 | - *optional* `summary` <[string]> Overrides user-visible description of the state 70 | 71 | --- 72 | 73 | 74 | #### type: Security.CertificateId 75 | 76 | An internal certificate ID value. 77 | 78 | *base type* 79 | - **integer** 80 | 81 | *property of type* 82 | - [Network.SecurityDetails] 83 | 84 | --- 85 | 86 | 87 | #### type: Security.MixedContentType 88 | 89 | A description of mixed content (HTTP resources on HTTPS pages), as defined by 90 | https://www.w3.org/TR/mixed-content/#categories 91 | 92 | *base type* 93 | - **string** 94 | 95 | *property of type* 96 | - [Network.Request] 97 | - [Security.SecurityStateExplanation] 98 | 99 | --- 100 | 101 | 102 | #### type: Security.SecurityState 103 | 104 | The security level of a page or resource. 105 | 106 | *base type* 107 | - **string** 108 | 109 | *property of type* 110 | - [Security.InsecureContentStatus] 111 | - [Network.Response] 112 | - [Security.SecurityStateExplanation] 113 | 114 | *parameter in event* 115 | - [Security.securityStateChanged] 116 | 117 | --- 118 | 119 | 120 | #### type: Security.SecurityStateExplanation 121 | 122 | An explanation of an factor contributing to the security state. 123 | 124 | *base type* 125 | - **object** 126 | 127 | *properties* 128 | - `securityState` <[Security.SecurityState]> Security state representing the severity of the factor being explained 129 | - `summary` <[string]> Short phrase describing the type of factor 130 | - `description` <[string]> Full text explanation of the factor 131 | - `mixedContentType` <[Security.MixedContentType]> The type of mixed content described by the explanation 132 | - `certificate` Page certificate 133 | 134 | *parameter in event* 135 | - [Security.securityStateChanged] 136 | 137 | --- 138 | 139 | 140 | #### type: Security.InsecureContentStatus 141 | 142 | Information about insecure content on the page. 143 | 144 | *base type* 145 | - **object** 146 | 147 | *properties* 148 | - `ranMixedContent` <[boolean]> True if the page was loaded over HTTPS and ran mixed (HTTP) content such as scripts 149 | - `displayedMixedContent` <[boolean]> True if the page was loaded over HTTPS and displayed mixed (HTTP) content such as images 150 | - `containedMixedForm` <[boolean]> True if the page was loaded over HTTPS and contained a form targeting an insecure url 151 | - `ranContentWithCertErrors` <[boolean]> True if the page was loaded over HTTPS without certificate errors, and ran content such as 152 | scripts that were loaded with certificate errors 153 | - `displayedContentWithCertErrors` <[boolean]> True if the page was loaded over HTTPS without certificate errors, and displayed content 154 | such as images that were loaded with certificate errors 155 | - `ranInsecureContentStyle` <[Security.SecurityState]> Security state representing a page that ran insecure content 156 | - `displayedInsecureContentStyle` <[Security.SecurityState]> Security state representing a page that displayed insecure content 157 | 158 | *parameter in event* 159 | - [Security.securityStateChanged] 160 | 161 | --- 162 | 163 | 164 | #### type: Security.CertificateErrorAction 165 | 166 | The action to take when a certificate error occurs. continue will continue processing the 167 | request and cancel will cancel the request. 168 | 169 | *base type* 170 | - **string** 171 | 172 | *accepted by command* 173 | - [Security.handleCertificateError] 174 | 175 | [Network.SecurityDetails]: network.md#type-networksecuritydetails "Network.SecurityDetails" 176 | [Network.Request]: network.md#type-networkrequest "Network.Request" 177 | [Security.SecurityStateExplanation]: security.md#type-securitysecuritystateexplanation "Security.SecurityStateExplanation" 178 | [Security.InsecureContentStatus]: security.md#type-securityinsecurecontentstatus "Security.InsecureContentStatus" 179 | [Network.Response]: network.md#type-networkresponse "Network.Response" 180 | [Security.SecurityStateExplanation]: security.md#type-securitysecuritystateexplanation "Security.SecurityStateExplanation" 181 | [Security.securityStateChanged]: security.md#event-securitysecuritystatechanged "Security.securityStateChanged" 182 | [Security.securityStateChanged]: security.md#event-securitysecuritystatechanged "Security.securityStateChanged" 183 | [Security.securityStateChanged]: security.md#event-securitysecuritystatechanged "Security.securityStateChanged" 184 | [Security.handleCertificateError]: security.md#command-securityhandlecertificateerror "Security.handleCertificateError" 185 | [Security.SecurityState]: security.md#type-securitysecuritystate "Security.SecurityState" 186 | [Security.MixedContentType]: security.md#type-securitymixedcontenttype "Security.MixedContentType" 187 | [Security.SecurityState]: security.md#type-securitysecuritystate "Security.SecurityState" 188 | [Security.CertificateErrorAction]: security.md#type-securitycertificateerroraction "Security.CertificateErrorAction" 189 | [Security.SecurityState]: security.md#type-securitysecuritystate "Security.SecurityState" 190 | [Security.SecurityStateExplanation]: security.md#type-securitysecuritystateexplanation "Security.SecurityStateExplanation" 191 | [Security.InsecureContentStatus]: security.md#type-securityinsecurecontentstatus "Security.InsecureContentStatus" 192 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 193 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 194 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 195 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 196 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 197 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/heapprofiler.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: HeapProfiler 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: HeapProfiler.addInspectedHeapObject 8 | 9 | Enables console to refer to the node with given id via $x (see Command Line API for more details 10 | $x functions). 11 | 12 | *parameters* 13 | - `heapObjectId` <[HeapProfiler.HeapSnapshotObjectId]> Heap snapshot object id to be accessible by means of $x command line API 14 | 15 | --- 16 | 17 | 18 | #### command: HeapProfiler.collectGarbage 19 | 20 | --- 21 | 22 | 23 | #### command: HeapProfiler.disable 24 | 25 | --- 26 | 27 | 28 | #### command: HeapProfiler.enable 29 | 30 | --- 31 | 32 | 33 | #### command: HeapProfiler.getHeapObjectId 34 | 35 | *parameters* 36 | - `objectId` <[Runtime.RemoteObjectId]> Identifier of the object to get heap object id for 37 | 38 | *returns* 39 | - `heapSnapshotObjectId` <[HeapProfiler.HeapSnapshotObjectId]> Id of the heap snapshot object corresponding to the passed remote object id 40 | 41 | --- 42 | 43 | 44 | #### command: HeapProfiler.getObjectByHeapObjectId 45 | 46 | *parameters* 47 | - `objectId` <[HeapProfiler.HeapSnapshotObjectId]> 48 | - *optional* `objectGroup` <[string]> Symbolic group name that can be used to release multiple objects 49 | 50 | *returns* 51 | - `result` <[Runtime.RemoteObject]> Evaluation result 52 | 53 | --- 54 | 55 | 56 | #### command: HeapProfiler.getSamplingProfile 57 | 58 | *returns* 59 | - `profile` <[HeapProfiler.SamplingHeapProfile]> Return the sampling profile being collected 60 | 61 | --- 62 | 63 | 64 | #### command: HeapProfiler.startSampling 65 | 66 | *parameters* 67 | - *optional* `samplingInterval` <[number]> Average sample interval in bytes. Poisson distribution is used for the intervals. The 68 | default value is 32768 bytes 69 | 70 | --- 71 | 72 | 73 | #### command: HeapProfiler.startTrackingHeapObjects 74 | 75 | *parameters* 76 | - *optional* `trackAllocations` <[boolean]> 77 | 78 | --- 79 | 80 | 81 | #### command: HeapProfiler.stopSampling 82 | 83 | *returns* 84 | - `profile` <[HeapProfiler.SamplingHeapProfile]> Recorded sampling heap profile 85 | 86 | --- 87 | 88 | 89 | #### command: HeapProfiler.stopTrackingHeapObjects 90 | 91 | *parameters* 92 | - *optional* `reportProgress` <[boolean]> If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken 93 | when the tracking is stopped 94 | 95 | --- 96 | 97 | 98 | #### command: HeapProfiler.takeHeapSnapshot 99 | 100 | *parameters* 101 | - *optional* `reportProgress` <[boolean]> If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken 102 | 103 | --- 104 | 105 | 106 | #### event: HeapProfiler.addHeapSnapshotChunk 107 | 108 | *parameters* 109 | - `chunk` <[string]> 110 | 111 | --- 112 | 113 | 114 | #### event: HeapProfiler.heapStatsUpdate 115 | 116 | If heap objects tracking has been started then backend may send update for one or more fragments 117 | 118 | *parameters* 119 | - `statsUpdate` An array of triplets. Each triplet describes a fragment. The first integer is the fragment 120 | index, the second integer is a total count of objects for the fragment, the third integer is 121 | a total size of the objects for the fragment 122 | 123 | --- 124 | 125 | 126 | #### event: HeapProfiler.lastSeenObjectId 127 | 128 | If heap objects tracking has been started then backend regularly sends a current value for last 129 | seen object id and corresponding timestamp. If the were changes in the heap since last event 130 | then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event. 131 | 132 | *parameters* 133 | - `lastSeenObjectId` <[integer]> 134 | - `timestamp` <[number]> 135 | 136 | --- 137 | 138 | 139 | #### event: HeapProfiler.reportHeapSnapshotProgress 140 | 141 | *parameters* 142 | - `done` <[integer]> 143 | - `total` <[integer]> 144 | - *optional* `finished` <[boolean]> 145 | 146 | --- 147 | 148 | 149 | #### event: HeapProfiler.resetProfiles 150 | 151 | --- 152 | 153 | 154 | #### type: HeapProfiler.HeapSnapshotObjectId 155 | 156 | Heap snapshot object id. 157 | 158 | *base type* 159 | - **string** 160 | 161 | *accepted by command* 162 | - [HeapProfiler.addInspectedHeapObject] 163 | - [HeapProfiler.getObjectByHeapObjectId] 164 | 165 | *returned from command* 166 | - [HeapProfiler.getHeapObjectId] 167 | 168 | --- 169 | 170 | 171 | #### type: HeapProfiler.SamplingHeapProfileNode 172 | 173 | Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes. 174 | 175 | *base type* 176 | - **object** 177 | 178 | *properties* 179 | - `callFrame` <[Runtime.CallFrame]> Function location 180 | - `selfSize` <[number]> Allocations size in bytes for the node excluding children 181 | - `children` Child nodes 182 | 183 | *property of type* 184 | - [HeapProfiler.SamplingHeapProfile] 185 | - [HeapProfiler.SamplingHeapProfileNode] 186 | 187 | --- 188 | 189 | 190 | #### type: HeapProfiler.SamplingHeapProfile 191 | 192 | Profile. 193 | 194 | *base type* 195 | - **object** 196 | 197 | *properties* 198 | - `head` <[HeapProfiler.SamplingHeapProfileNode]> 199 | 200 | *returned from command* 201 | - [HeapProfiler.getSamplingProfile] 202 | - [HeapProfiler.stopSampling] 203 | 204 | [HeapProfiler.addInspectedHeapObject]: heapprofiler.md#command-heapprofileraddinspectedheapobject "HeapProfiler.addInspectedHeapObject" 205 | [HeapProfiler.getObjectByHeapObjectId]: heapprofiler.md#command-heapprofilergetobjectbyheapobjectid "HeapProfiler.getObjectByHeapObjectId" 206 | [HeapProfiler.getHeapObjectId]: heapprofiler.md#command-heapprofilergetheapobjectid "HeapProfiler.getHeapObjectId" 207 | [HeapProfiler.SamplingHeapProfile]: heapprofiler.md#type-heapprofilersamplingheapprofile "HeapProfiler.SamplingHeapProfile" 208 | [HeapProfiler.SamplingHeapProfileNode]: heapprofiler.md#type-heapprofilersamplingheapprofilenode "HeapProfiler.SamplingHeapProfileNode" 209 | [HeapProfiler.getSamplingProfile]: heapprofiler.md#command-heapprofilergetsamplingprofile "HeapProfiler.getSamplingProfile" 210 | [HeapProfiler.stopSampling]: heapprofiler.md#command-heapprofilerstopsampling "HeapProfiler.stopSampling" 211 | [Runtime.CallFrame]: runtime.md#type-runtimecallframe "Runtime.CallFrame" 212 | [HeapProfiler.SamplingHeapProfileNode]: heapprofiler.md#type-heapprofilersamplingheapprofilenode "HeapProfiler.SamplingHeapProfileNode" 213 | [HeapProfiler.SamplingHeapProfileNode]: heapprofiler.md#type-heapprofilersamplingheapprofilenode "HeapProfiler.SamplingHeapProfileNode" 214 | [HeapProfiler.HeapSnapshotObjectId]: heapprofiler.md#type-heapprofilerheapsnapshotobjectid "HeapProfiler.HeapSnapshotObjectId" 215 | [Runtime.RemoteObjectId]: runtime.md#type-runtimeremoteobjectid "Runtime.RemoteObjectId" 216 | [HeapProfiler.HeapSnapshotObjectId]: heapprofiler.md#type-heapprofilerheapsnapshotobjectid "HeapProfiler.HeapSnapshotObjectId" 217 | [HeapProfiler.HeapSnapshotObjectId]: heapprofiler.md#type-heapprofilerheapsnapshotobjectid "HeapProfiler.HeapSnapshotObjectId" 218 | [Runtime.RemoteObject]: runtime.md#type-runtimeremoteobject "Runtime.RemoteObject" 219 | [HeapProfiler.SamplingHeapProfile]: heapprofiler.md#type-heapprofilersamplingheapprofile "HeapProfiler.SamplingHeapProfile" 220 | [HeapProfiler.SamplingHeapProfile]: heapprofiler.md#type-heapprofilersamplingheapprofile "HeapProfiler.SamplingHeapProfile" 221 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 222 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 223 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 224 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 225 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 226 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/domsnapshot.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: DOMSnapshot 🌱 3 | 4 | This domain facilitates obtaining document snapshots with DOM, layout, and style information. 5 | 6 | --- 7 | 8 | 9 | #### command: DOMSnapshot.getSnapshot 10 | 11 | Returns a document snapshot, including the full DOM tree of the root node (including iframes, 12 | template contents, and imported documents) in a flattened array, as well as layout and 13 | white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is 14 | flattened. 15 | 16 | *parameters* 17 | - `computedStyleWhitelist` Whitelist of computed styles to return 18 | 19 | *returns* 20 | - `domNodes` The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document 21 | - `layoutTreeNodes` The nodes in the layout tree 22 | - `computedStyles` Whitelisted ComputedStyle properties for each node in the layout tree 23 | 24 | --- 25 | 26 | 27 | #### type: DOMSnapshot.DOMNode 28 | 29 | A Node in the DOM tree. 30 | 31 | *base type* 32 | - **object** 33 | 34 | *properties* 35 | - `nodeType` <[integer]> `Node`'s nodeType 36 | - `nodeName` <[string]> `Node`'s nodeName 37 | - `nodeValue` <[string]> `Node`'s nodeValue 38 | - *optional* `textValue` <[string]> Only set for textarea elements, contains the text value 39 | - *optional* `inputValue` <[string]> Only set for input elements, contains the input's associated text value 40 | - *optional* `inputChecked` <[boolean]> Only set for radio and checkbox input elements, indicates if the element has been checked 41 | - *optional* `optionSelected` <[boolean]> Only set for option elements, indicates if the element has been selected 42 | - `backendNodeId` <[DOM.BackendNodeId]> `Node`'s id, corresponds to DOM.Node.backendNodeId 43 | - *optional* `childNodeIndexes` The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if 44 | any 45 | - *optional* `attributes` Attributes of an `Element` node 46 | - *optional* `pseudoElementIndexes` Indexes of pseudo elements associated with this node in the `domNodes` array returned by 47 | `getSnapshot`, if any 48 | - *optional* `layoutNodeIndex` <[integer]> The index of the node's related layout tree node in the `layoutTreeNodes` array returned by 49 | `getSnapshot`, if any 50 | - *optional* `documentURL` <[string]> Document URL that `Document` or `FrameOwner` node points to 51 | - *optional* `baseURL` <[string]> Base URL that `Document` or `FrameOwner` node uses for URL completion 52 | - *optional* `contentLanguage` <[string]> Only set for documents, contains the document's content language 53 | - *optional* `documentEncoding` <[string]> Only set for documents, contains the document's character set encoding 54 | - *optional* `publicId` <[string]> `DocumentType` node's publicId 55 | - *optional* `systemId` <[string]> `DocumentType` node's systemId 56 | - *optional* `frameId` <[Page.FrameId]> Frame ID for frame owner elements and also for the document node 57 | - *optional* `contentDocumentIndex` <[integer]> The index of a frame owner element's content document in the `domNodes` array returned by 58 | `getSnapshot`, if any 59 | - *optional* `importedDocumentIndex` <[integer]> Index of the imported document's node of a link element in the `domNodes` array returned by 60 | `getSnapshot`, if any 61 | - *optional* `templateContentIndex` <[integer]> Index of the content node of a template element in the `domNodes` array returned by 62 | `getSnapshot` 63 | - *optional* `pseudoType` <[DOM.PseudoType]> Type of a pseudo element node 64 | - *optional* `isClickable` <[boolean]> Whether this DOM node responds to mouse clicks. This includes nodes that have had click 65 | event listeners attached via JavaScript as well as anchor tags that naturally navigate when 66 | clicked 67 | 68 | *returned from command* 69 | - [DOMSnapshot.getSnapshot] 70 | 71 | --- 72 | 73 | 74 | #### type: DOMSnapshot.InlineTextBox 75 | 76 | Details of post layout rendered text positions. The exact layout should not be regarded as 77 | stable and may change between versions. 78 | 79 | *base type* 80 | - **object** 81 | 82 | *properties* 83 | - `boundingBox` <[DOM.Rect]> The absolute position bounding box 84 | - `startCharacterIndex` <[integer]> The starting index in characters, for this post layout textbox substring 85 | - `numCharacters` <[integer]> The number of characters in this post layout textbox substring 86 | 87 | *property of type* 88 | - [DOMSnapshot.LayoutTreeNode] 89 | 90 | --- 91 | 92 | 93 | #### type: DOMSnapshot.LayoutTreeNode 94 | 95 | Details of an element in the DOM tree with a LayoutObject. 96 | 97 | *base type* 98 | - **object** 99 | 100 | *properties* 101 | - `domNodeIndex` <[integer]> The index of the related DOM node in the `domNodes` array returned by `getSnapshot` 102 | - `boundingBox` <[DOM.Rect]> The absolute position bounding box 103 | - *optional* `layoutText` <[string]> Contents of the LayoutText, if any 104 | - *optional* `inlineTextNodes` The post-layout inline text nodes, if any 105 | - *optional* `styleIndex` <[integer]> Index into the `computedStyles` array returned by `getSnapshot` 106 | 107 | *returned from command* 108 | - [DOMSnapshot.getSnapshot] 109 | 110 | --- 111 | 112 | 113 | #### type: DOMSnapshot.ComputedStyle 114 | 115 | A subset of the full ComputedStyle as defined by the request whitelist. 116 | 117 | *base type* 118 | - **object** 119 | 120 | *properties* 121 | - `properties` Name/value pairs of computed style properties 122 | 123 | *returned from command* 124 | - [DOMSnapshot.getSnapshot] 125 | 126 | --- 127 | 128 | 129 | #### type: DOMSnapshot.NameValue 130 | 131 | A name/value pair. 132 | 133 | *base type* 134 | - **object** 135 | 136 | *properties* 137 | - `name` <[string]> Attribute/property name 138 | - `value` <[string]> Attribute/property value 139 | 140 | *property of type* 141 | - [DOMSnapshot.ComputedStyle] 142 | - [DOMSnapshot.DOMNode] 143 | 144 | [DOMSnapshot.getSnapshot]: domsnapshot.md#command-domsnapshotgetsnapshot "DOMSnapshot.getSnapshot" 145 | [DOMSnapshot.LayoutTreeNode]: domsnapshot.md#type-domsnapshotlayouttreenode "DOMSnapshot.LayoutTreeNode" 146 | [DOMSnapshot.getSnapshot]: domsnapshot.md#command-domsnapshotgetsnapshot "DOMSnapshot.getSnapshot" 147 | [DOMSnapshot.getSnapshot]: domsnapshot.md#command-domsnapshotgetsnapshot "DOMSnapshot.getSnapshot" 148 | [DOMSnapshot.ComputedStyle]: domsnapshot.md#type-domsnapshotcomputedstyle "DOMSnapshot.ComputedStyle" 149 | [DOMSnapshot.DOMNode]: domsnapshot.md#type-domsnapshotdomnode "DOMSnapshot.DOMNode" 150 | [DOM.BackendNodeId]: dom.md#type-dombackendnodeid "DOM.BackendNodeId" 151 | [DOMSnapshot.NameValue]: domsnapshot.md#type-domsnapshotnamevalue "DOMSnapshot.NameValue" 152 | [Page.FrameId]: page.md#type-pageframeid "Page.FrameId" 153 | [DOM.PseudoType]: dom.md#type-dompseudotype "DOM.PseudoType" 154 | [DOM.Rect]: dom.md#type-domrect "DOM.Rect" 155 | [DOM.Rect]: dom.md#type-domrect "DOM.Rect" 156 | [DOMSnapshot.InlineTextBox]: domsnapshot.md#type-domsnapshotinlinetextbox "DOMSnapshot.InlineTextBox" 157 | [DOMSnapshot.NameValue]: domsnapshot.md#type-domsnapshotnamevalue "DOMSnapshot.NameValue" 158 | [DOMSnapshot.DOMNode]: domsnapshot.md#type-domsnapshotdomnode "DOMSnapshot.DOMNode" 159 | [DOMSnapshot.LayoutTreeNode]: domsnapshot.md#type-domsnapshotlayouttreenode "DOMSnapshot.LayoutTreeNode" 160 | [DOMSnapshot.ComputedStyle]: domsnapshot.md#type-domsnapshotcomputedstyle "DOMSnapshot.ComputedStyle" 161 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 162 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 163 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 164 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 165 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 166 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/overlay.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Overlay 🌱 3 | 4 | This domain provides various functionality related to drawing atop the inspected page. 5 | 6 | --- 7 | 8 | 9 | #### command: Overlay.disable 10 | 11 | Disables domain notifications. 12 | 13 | --- 14 | 15 | 16 | #### command: Overlay.enable 17 | 18 | Enables domain notifications. 19 | 20 | --- 21 | 22 | 23 | #### command: Overlay.getHighlightObjectForTest 24 | 25 | For testing. 26 | 27 | *parameters* 28 | - `nodeId` <[DOM.NodeId]> Id of the node to get highlight object for 29 | 30 | *returns* 31 | - `highlight` <[object]> Highlight data for the node 32 | 33 | --- 34 | 35 | 36 | #### command: Overlay.hideHighlight 37 | 38 | Hides any highlight. 39 | 40 | --- 41 | 42 | 43 | #### command: Overlay.highlightFrame 44 | 45 | Highlights owner element of the frame with given id. 46 | 47 | *parameters* 48 | - `frameId` <[Page.FrameId]> Identifier of the frame to highlight 49 | - *optional* `contentColor` <[DOM.RGBA]> The content box highlight fill color (default: transparent) 50 | - *optional* `contentOutlineColor` <[DOM.RGBA]> The content box highlight outline color (default: transparent) 51 | 52 | --- 53 | 54 | 55 | #### command: Overlay.highlightNode 56 | 57 | Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or 58 | objectId must be specified. 59 | 60 | *parameters* 61 | - `highlightConfig` <[Overlay.HighlightConfig]> A descriptor for the highlight appearance 62 | - *optional* `nodeId` <[DOM.NodeId]> Identifier of the node to highlight 63 | - *optional* `backendNodeId` <[DOM.BackendNodeId]> Identifier of the backend node to highlight 64 | - *optional* `objectId` <[Runtime.RemoteObjectId]> JavaScript object id of the node to be highlighted 65 | 66 | --- 67 | 68 | 69 | #### command: Overlay.highlightQuad 70 | 71 | Highlights given quad. Coordinates are absolute with respect to the main frame viewport. 72 | 73 | *parameters* 74 | - `quad` <[DOM.Quad]> Quad to highlight 75 | - *optional* `color` <[DOM.RGBA]> The highlight fill color (default: transparent) 76 | - *optional* `outlineColor` <[DOM.RGBA]> The highlight outline color (default: transparent) 77 | 78 | --- 79 | 80 | 81 | #### command: Overlay.highlightRect 82 | 83 | Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport. 84 | 85 | *parameters* 86 | - `x` <[integer]> X coordinate 87 | - `y` <[integer]> Y coordinate 88 | - `width` <[integer]> Rectangle width 89 | - `height` <[integer]> Rectangle height 90 | - *optional* `color` <[DOM.RGBA]> The highlight fill color (default: transparent) 91 | - *optional* `outlineColor` <[DOM.RGBA]> The highlight outline color (default: transparent) 92 | 93 | --- 94 | 95 | 96 | #### command: Overlay.setInspectMode 97 | 98 | Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. 99 | Backend then generates 'inspectNodeRequested' event upon element selection. 100 | 101 | *parameters* 102 | - `mode` <[Overlay.InspectMode]> Set an inspection mode 103 | - *optional* `highlightConfig` <[Overlay.HighlightConfig]> A descriptor for the highlight appearance of hovered-over nodes. May be omitted if `enabled 104 | == false` 105 | 106 | --- 107 | 108 | 109 | #### command: Overlay.setPausedInDebuggerMessage 110 | 111 | *parameters* 112 | - *optional* `message` <[string]> The message to display, also triggers resume and step over controls 113 | 114 | --- 115 | 116 | 117 | #### command: Overlay.setShowDebugBorders 118 | 119 | Requests that backend shows debug borders on layers 120 | 121 | *parameters* 122 | - `show` <[boolean]> True for showing debug borders 123 | 124 | --- 125 | 126 | 127 | #### command: Overlay.setShowFPSCounter 128 | 129 | Requests that backend shows the FPS counter 130 | 131 | *parameters* 132 | - `show` <[boolean]> True for showing the FPS counter 133 | 134 | --- 135 | 136 | 137 | #### command: Overlay.setShowPaintRects 138 | 139 | Requests that backend shows paint rectangles 140 | 141 | *parameters* 142 | - `result` <[boolean]> True for showing paint rectangles 143 | 144 | --- 145 | 146 | 147 | #### command: Overlay.setShowScrollBottleneckRects 148 | 149 | Requests that backend shows scroll bottleneck rects 150 | 151 | *parameters* 152 | - `show` <[boolean]> True for showing scroll bottleneck rects 153 | 154 | --- 155 | 156 | 157 | #### command: Overlay.setShowViewportSizeOnResize 158 | 159 | Paints viewport size upon main frame resize. 160 | 161 | *parameters* 162 | - `show` <[boolean]> Whether to paint size or not 163 | 164 | --- 165 | 166 | 167 | #### command: Overlay.setSuspended 168 | 169 | *parameters* 170 | - `suspended` <[boolean]> Whether overlay should be suspended and not consume any resources until resumed 171 | 172 | --- 173 | 174 | 175 | #### event: Overlay.inspectNodeRequested 176 | 177 | Fired when the node should be inspected. This happens after call to `setInspectMode` or when 178 | user manually inspects an element. 179 | 180 | *parameters* 181 | - `backendNodeId` <[DOM.BackendNodeId]> Id of the node to inspect 182 | 183 | --- 184 | 185 | 186 | #### event: Overlay.nodeHighlightRequested 187 | 188 | Fired when the node should be highlighted. This happens after call to `setInspectMode`. 189 | 190 | *parameters* 191 | - `nodeId` <[DOM.NodeId]> 192 | 193 | --- 194 | 195 | 196 | #### event: Overlay.screenshotRequested 197 | 198 | Fired when user asks to capture screenshot of some area on the page. 199 | 200 | *parameters* 201 | - `viewport` <[Page.Viewport]> Viewport to capture, in CSS 202 | 203 | --- 204 | 205 | 206 | #### type: Overlay.HighlightConfig 207 | 208 | Configuration data for the highlighting of page elements. 209 | 210 | *base type* 211 | - **object** 212 | 213 | *properties* 214 | - *optional* `showInfo` <[boolean]> Whether the node info tooltip should be shown (default: false) 215 | - *optional* `showRulers` <[boolean]> Whether the rulers should be shown (default: false) 216 | - *optional* `showExtensionLines` <[boolean]> Whether the extension lines from node to the rulers should be shown (default: false) 217 | - *optional* `displayAsMaterial` <[boolean]> 218 | - *optional* `contentColor` <[DOM.RGBA]> The content box highlight fill color (default: transparent) 219 | - *optional* `paddingColor` <[DOM.RGBA]> The padding highlight fill color (default: transparent) 220 | - *optional* `borderColor` <[DOM.RGBA]> The border highlight fill color (default: transparent) 221 | - *optional* `marginColor` <[DOM.RGBA]> The margin highlight fill color (default: transparent) 222 | - *optional* `eventTargetColor` <[DOM.RGBA]> The event target element highlight fill color (default: transparent) 223 | - *optional* `shapeColor` <[DOM.RGBA]> The shape outside fill color (default: transparent) 224 | - *optional* `shapeMarginColor` <[DOM.RGBA]> The shape margin fill color (default: transparent) 225 | - *optional* `selectorList` <[string]> Selectors to highlight relevant nodes 226 | - *optional* `cssGridColor` <[DOM.RGBA]> The grid layout color (default: transparent) 227 | 228 | *accepted by command* 229 | - [Overlay.highlightNode] 230 | - [Overlay.setInspectMode] 231 | 232 | --- 233 | 234 | 235 | #### type: Overlay.InspectMode 236 | 237 | *base type* 238 | - **string** 239 | 240 | *accepted by command* 241 | - [Overlay.setInspectMode] 242 | 243 | [Overlay.highlightNode]: overlay.md#command-overlayhighlightnode "Overlay.highlightNode" 244 | [Overlay.setInspectMode]: overlay.md#command-overlaysetinspectmode "Overlay.setInspectMode" 245 | [Overlay.setInspectMode]: overlay.md#command-overlaysetinspectmode "Overlay.setInspectMode" 246 | [DOM.RGBA]: dom.md#type-domrgba "DOM.RGBA" 247 | [DOM.NodeId]: dom.md#type-domnodeid "DOM.NodeId" 248 | [Page.FrameId]: page.md#type-pageframeid "Page.FrameId" 249 | [DOM.RGBA]: dom.md#type-domrgba "DOM.RGBA" 250 | [Overlay.HighlightConfig]: overlay.md#type-overlayhighlightconfig "Overlay.HighlightConfig" 251 | [DOM.NodeId]: dom.md#type-domnodeid "DOM.NodeId" 252 | [DOM.BackendNodeId]: dom.md#type-dombackendnodeid "DOM.BackendNodeId" 253 | [Runtime.RemoteObjectId]: runtime.md#type-runtimeremoteobjectid "Runtime.RemoteObjectId" 254 | [DOM.Quad]: dom.md#type-domquad "DOM.Quad" 255 | [DOM.RGBA]: dom.md#type-domrgba "DOM.RGBA" 256 | [DOM.RGBA]: dom.md#type-domrgba "DOM.RGBA" 257 | [Overlay.InspectMode]: overlay.md#type-overlayinspectmode "Overlay.InspectMode" 258 | [Overlay.HighlightConfig]: overlay.md#type-overlayhighlightconfig "Overlay.HighlightConfig" 259 | [DOM.BackendNodeId]: dom.md#type-dombackendnodeid "DOM.BackendNodeId" 260 | [DOM.NodeId]: dom.md#type-domnodeid "DOM.NodeId" 261 | [Page.Viewport]: page.md#type-pageviewport "Page.Viewport" 262 | [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON boolean" 263 | [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON string" 264 | [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON number" 265 | [integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON integer" 266 | [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON object" 267 | [any]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON "JSON any" -------------------------------------------------------------------------------- /docs/accessibility.md: -------------------------------------------------------------------------------- 1 | 2 | ### domain: Accessibility 🌱 3 | 4 | --- 5 | 6 | 7 | #### command: Accessibility.getPartialAXTree 🌱 8 | 9 | Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists. 10 | 11 | *parameters* 12 | - `nodeId` <[DOM.NodeId]> ID of node to get the partial accessibility tree for 13 | - *optional* `fetchRelatives` <[boolean]> Whether to fetch this nodes ancestors, siblings and children. Defaults to true 14 | 15 | *returns* 16 | - `nodes` The `Accessibility.AXNode` for this DOM node, if it exists, plus its ancestors, siblings and 17 | children, if requested 18 | 19 | --- 20 | 21 | 22 | #### type: Accessibility.AXNodeId 23 | 24 | Unique accessibility node identifier. 25 | 26 | *base type* 27 | - **string** 28 | 29 | *property of type* 30 | - [Accessibility.AXNode] 31 | 32 | --- 33 | 34 | 35 | #### type: Accessibility.AXValueType 36 | 37 | Enum of possible property types. 38 | 39 | *base type* 40 | - **string** 41 | 42 | *property of type* 43 | - [Accessibility.AXValue] 44 | 45 | --- 46 | 47 | 48 | #### type: Accessibility.AXValueSourceType 49 | 50 | Enum of possible property sources. 51 | 52 | *base type* 53 | - **string** 54 | 55 | *property of type* 56 | - [Accessibility.AXValueSource] 57 | 58 | --- 59 | 60 | 61 | #### type: Accessibility.AXValueNativeSourceType 62 | 63 | Enum of possible native property sources (as a subtype of a particular AXValueSourceType). 64 | 65 | *base type* 66 | - **string** 67 | 68 | *property of type* 69 | - [Accessibility.AXValueSource] 70 | 71 | --- 72 | 73 | 74 | #### type: Accessibility.AXValueSource 75 | 76 | A single source for a computed AX property. 77 | 78 | *base type* 79 | - **object** 80 | 81 | *properties* 82 | - `type` <[Accessibility.AXValueSourceType]> What type of source this is 83 | - *optional* `value` <[Accessibility.AXValue]> The value of this property source 84 | - *optional* `attribute` <[string]> The name of the relevant attribute, if any 85 | - *optional* `attributeValue` <[Accessibility.AXValue]> The value of the relevant attribute, if any 86 | - *optional* `superseded` <[boolean]> Whether this source is superseded by a higher priority source 87 | - *optional* `nativeSource` <[Accessibility.AXValueNativeSourceType]> The native markup source for this value, e.g. a